Update label assignments

Update the expiry date of one or more label assignments in a single request. You can identify the label to update by its ID, name, or external ID. You can process up to 100 update items per request.

Example request

curl -X PUT "https://{host}/v2/labels/assignments" \
  -H "Authorization: Basic {base64_credentials}" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "CUSTOMER",
    "updates": [
      {
        "entityId": "<ENTITY_ID>",
        "labelId": 109,
        "expiryDate": "2028-01-01"
      }
    ]
  }'

Prerequisites

• Basic authentication (Authorization: Basic {base64_credentials}) or OAuth (X-CAP-API-OAUTH-TOKEN).

Body parameters

Note: The Updatable column indicates which fields can be changed. The expiryDate is the only updatable field — all other fields identify which assignment to update.

Example response

{
  "data": [
    {
      "assignmentId": 1,
      "entityId": "<ENTITY_ID>",
      "labelId": 109,
      "labelName": "VIP",
      "labelExternalId": "vip-tier",
      "expiryDate": "2028-01-01T00:00:00Z"
    }
  ],
  "warnings": [],
  "errors": []
}

Response parameters

Note: The expiryDate field requires the org to have a timezone configured. If the org timezone is not set, the API returns HTTP 400 with no response body.

Error & warning codes