Update territory

Update a territory

PUT /revenueOrganization/territories/{uuid}

Update territory

cURL

curl --request PUT \
  --url https://api.getcargo.io/v1/revenueOrganization/territories/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>",
  "members": [
    {
      "uuid": "<string>",
      "weight": 123
    }
  ],
  "fallbackMemberUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

200

{
  "territory": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "label": "<string>",
    "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.

Path Parameters

uuid · string<uuid> · required

Territory identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

label · string

Territory label.

color · enum<string>

Territory color.

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

description · string | null

Territory description.

members · Members · object[]

Territory members.

Show child attributes

fallbackMemberUuid · string<uuid> | null

Fallback member identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

200

application/json

Successful response

territory · Territory · object · required

Updated territory details.

Show child attributes