latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Campaigns

Unassign designations from a campaign

This request allows you to unassign designations from a campaign. Each item is processed independently; the response reports the per-item outcome. Only base campaign types are supported.

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

Path parameters

idstring required
Example:FUNXXXXXXXX

Unique identifier of the campaign, formatted as FUN[A-Z\d]{8}.

Request body

livemodeboolean

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026.

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 campaign."
      },
      "id": "EXXXXXXX"
    }
  ],
  "status": "complete"
}