POST/v1/blasts/{id}/cancel

Cancel a blast

Closes a blast with a reason so it never goes: {"reason": "…"}. Allowed while it is a draft or scheduled only — once dispatch has started, the copies are in the outbox and this answers 409, so withdraw them one at a time with post_comms_messages_id_cancel. There is no route that deletes a blast and no grant for one: that a workspace aimed a message at a list of people outlives the campaign, and cancel is the verb.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "audienceFilter": {},
    "audienceFrozenAt": "string",
    "body": "string",
    "cancellationReason": "string",
    "cancelledAt": "string",
    "createdAt": "string",
    "createdByUserId": 1,
    "detail": {},
    "id": 1,
    "kind": "string",
    "name": "string",
    "retargetOfBlastId": 1,
    "scheduledAt": "string",
    "sentAt": "string",
    "status": "string",
    "subject": "string",
    "templateId": 1,
    "updatedAt": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired