Skip to main content
POST
/
revenueOrganization
/
capacities
Create capacity
curl --request POST \
  --url https://api.getcargo.io/v1/revenueOrganization/capacities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "color": "orange",
  "description": "<string>",
  "modelUuid": "<string>",
  "idColumnSlug": "<string>",
  "timeColumnSlug": "<string>",
  "memberCapacity": 123,
  "allocationExpirationPolicy": {
    "interval": "<string>",
    "minute": 123
  },
  "filter": {
    "conjonction": "or",
    "groups": [
      {}
    ]
  }
}
'
{
  "capacity": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "name": "<string>",
    "color": "orange",
    "description": "<string>",
    "memberCapacity": 123,
    "allocationExpirationPolicy": {
      "interval": "<string>",
      "minute": 123
    },
    "modelUuid": "<string>",
    "idColumnSlug": "<string>",
    "timeColumnSlug": "<string>",
    "filter": {
      "conjonction": "or",
      "groups": [
        {}
      ]
    },
    "syncedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

name
string
required

Capacity name.

color
enum<string>
required

Capacity color.

Available options:
orange,
red,
purple,
green,
yellow,
grey
description
string

Capacity description.

modelUuid
string

Model identifier for capacity mapping.

idColumnSlug
string

Identifier column slug.

timeColumnSlug
string

Time column slug.

memberCapacity
number

Capacity per member.

allocationExpirationPolicy
Allocation expiration policy · object

Allocation expiration schedule.

filter
Filter · object

Filter criteria for capacity.

Response

Successful response

capacity
Capacity · object
required

Created capacity details.