Cancel a broadcast
POST/v1/broadcasts/{id}/cancel
Stops a scheduled, sending or paused broadcast. Messages already sent are not recalled.
Required scope: broadcasts:manage
Parameters
| Name | In | Description |
|---|---|---|
idrequired | path | The broadcast id. |
Example
curl -X POST 'https://api.sendsend.email/v1/broadcasts/ID/cancel' \
-H "Authorization: Bearer $SENDSEND_API_KEY"Response 200
{
"id": "bcast_Tz8…",
"object": "broadcast",
"name": "October update",
"audience_id": "aud_7Qe2…",
"topic_id": null,
"from": "Acme <news@mail.acme.com>",
"subject": "What’s new, {{{FIRST_NAME|there}}}",
"status": "cancelled",
"status_reason": null,
"scheduled_at": null,
"sent": 0,
"skipped": 0,
"failed": 0,
"created_at": "2026-10-06T15:00:00.000Z"
}Errors
| Status | Code | When |
|---|---|---|
| 404 | not_found | No such resource in this project. |
| 409 | not_schedulable | The broadcast is a draft or already finished. |
| 401 | unauthorized | The API key is missing, invalid or revoked. |
| 403 | forbidden | The key does not have the scope this endpoint needs. |
Every error has the same shape. See Errors.