Skip to main content
POST
/
revenueOrganization
/
territories
Create territory
curl --request POST \
  --url https://api.getcargo.io/v1/revenueOrganization/territories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "color": "orange",
  "members": [
    {
      "uuid": "<string>",
      "weight": 123
    }
  ],
  "description": "<string>",
  "fallbackMemberUuid": "<string>"
}
'
{
  "territory": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "label": "<string>",
    "color": "orange",
    "description": "<string>",
    "members": [
      {
        "uuid": "<string>",
        "weight": 123
      }
    ],
    "fallbackMemberUuid": "<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.

label
string
required

Territory label.

color
enum<string>
required

Territory color.

Available options:
orange,
red,
purple,
green,
yellow,
grey
members
Members · object[]
required

Territory members.

description
string

Territory description.

fallbackMemberUuid
string

Fallback member identifier.

Response

Successful response

territory
Territory · object
required

Created territory details.