# 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`.

## Endpoint

`POST /v1/blasts/{id}/cancel`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| id | path | string | Yes |

## Request body

Content type: `application/json`.

```json
{
  "body": {
    "reason": "string"
  },
  "params": {
    ":id": "string"
  },
  "query": {}
}
```

## Responses

### 201

the action's answer

Content type: `application/json`.

```json
{
  "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"
  }
}
```

### default

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.

Content type: `application/json`.

```json
{
  "error": "string"
}
```