Cancel a scheduled campaign
Moves a `scheduled` campaign back to `draft` (clearing its send time) so it can be edited. A campaign the worker has already claimed can't be canceled.
Moves a scheduled campaign back to draft (clearing its send time) so it can be edited. A campaign the worker has already claimed can't be canceled.
Authorization
bearerAuth campaigns:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: campaigns:update
Path Parameters
The campaign id.
Header Parameters
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "name": "string", "status": "draft", "subject": "string", "preview_text": "string", "from_name": "string", "from_email": "string", "reply_to": "string", "sending_domain_ref": "string", "audience_list_id": "string", "design_json": null, "html": "string", "text_body": "string", "ab_config": null, "scheduled_at": "string", "sent_at": "string", "metadata": { "property1": "string", "property2": "string" }, "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}