Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designations

Delete multiple designations

Use this request to delete multiple designations at once. Each designation is processed independently. A designation cannot be deleted if it is the default designation of the account or is in use.

post/v1/designations/batch/delete

Request body

livemodeboolean

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

Example request

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

Response

Returns the result of the batch delete operation, including the status of each designation.

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

Status of the bulk operation.

Example response

{
  "results": [
    {
      "error": {
        "code": "designation_not_found",
        "message": "Designation not found."
      },
      "id": "EXXXXXXX"
    }
  ],
  "status": "complete"
}