Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designation groups

Unassign designations from a designation group

Use this request to detach one or more designations from a designation group. Each item is processed independently; the response reports the per-item outcome.

post/v1/designation_groups/{id}/designations/unassign

Path parameters

idstring required
Example:LXXXXXXX

Unique identifier of the designation group, formatted as L[A-Z\d]{7}.

Request body

livemodeboolean

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Designation groups only exist in live mode — set this to true.

Example request

{
  "items": [
    {
      "id": "EXXXXXXX"
    }
  ],
  "livemode": true
}

Response

On success, the API returns the overall status and a per-item result array describing which designations were detached.

status'complete' | 'partial' | 'failed' required

Status of the bulk operation.

Example response

{
  "results": [
    {
      "error": {
        "code": "designation_not_attached",
        "message": "Designation is not attached to this group."
      },
      "id": "EXXXXXXX"
    }
  ],
  "status": "partial"
}