Update label assignments (PUT)

Updates the expiry date of existing label assignments in bulk. An organization can update up to 10 assignments per request. Returns HTTP 200 if all succeed, HTTP 207 if some fail, or HTTP 400 if all fail.

Example request

curl -X PUT "https://{host}/api_gateway/v2/labels/assignments" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "PRODUCT",
    "updates": [
      {
        "entityId": "SKU-001",
        "labelId": 101,
        "expiryDate": "2026-12-31"
      }
    ]
  }'

Prerequisites

Requires authentication with a valid bearer token.
The token must have write access to the Labels resource.

Body parameters

Note: The Updatable column indicates whether a field can be changed after the assignment is created. Fields marked No identify the assignment to update.

Field	Type	Required	Description	Updatable
`entityType`	enum	Required	Entity type of the assigned entity. One of: `CUSTOMER`, `PRODUCT`, `STORE`.	No
`updates`	array	Required	List of assignment update objects. Maximum 10 per request.	—
`.entityId`	string	Required	Identifier of the entity whose assignment is being updated.	No
`.labelId`	integer	Conditional	System-assigned identifier of the label. Exactly one of `labelId`, `labelName`, or `labelExternalId` must be provided.	No
`.labelName`	string	Conditional	Display name of the label. Exactly one of `labelId`, `labelName`, or `labelExternalId` must be provided.	No
`.labelExternalId`	string	Conditional	Caller-defined identifier of the label. Exactly one of `labelId`, `labelName`, or `labelExternalId` must be provided.	No
`.expiryDate`	string	Required	New expiry date for the assignment. Format: `YYYY-MM-DD`. Must be a future date.	Yes

Example response

{
  "data": [
    {
      "assignmentId": 5001,
      "entityId": "SKU-001",
      "labelId": 101,
      "labelName": "Summer Sale",
      "labelExternalId": "SUMMER_SALE",
      "expiryDate": "2026-12-31"
    }
  ],
  "warnings": [],
  "errors": []
}

Response parameters

Field	Type	Description
`data`	array	Assignments updated successfully.
`.assignmentId`	integer	System-assigned unique identifier for the assignment.
`.entityId`	string	Entity identifier.
`.labelId`	integer	System-assigned identifier of the label.
`.labelName`	string	Display name of the assigned label.
`.labelExternalId`	string	Caller-defined identifier of the assigned label, or null if not set.
`.expiryDate`	string	Updated expiry date in `YYYY-MM-DD` format.
`warnings`	array	Non-fatal issues. Each item includes a code and message.
`errors`	array	Assignments that failed to update. Each item includes a code, message, and the rejected input.

Error & warning codes

Code	Error number	Type	Description
`LABEL_INVALID_ENTITY_TYPE`	23006	Error	`entityType` is not one of `CUSTOMER`, `PRODUCT`, `STORE`. HTTP 400.
`ASSIGNMENT_BATCH_SIZE_EXCEEDED`	23032	Error	More than 10 updates in a single request. HTTP 400.