API · Broadcasts

Cancel Broadcast

Cancel a scheduled broadcast before recipient selection begins (requires full access). Once sending begins, the broadcast cannot be canceled and submitted emails cannot be recalled.

POST/broadcasts/{id}/cancelFull access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.
`Idempotency-Key` header · optional	`string` 1–256 characters	Makes the request safe to retry. See Idempotency.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X POST "$OPENSEND_BASE_URL/broadcasts/YOUR_id/cancel" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "broadcast",
  "id": "YOUR_ID"
}

Behavior and errors

Cancel before audience resolution begins. Accepted SES messages cannot be recalled.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.