Cancel Broadcast

Cancel a broadcast that is scheduled or queued.

POST/broadcasts/{broadcast_id}/cancel

Requires a full_access API key.

What cancelling does, per status

Status	Result
`scheduled`	Returns to `draft`. No email was ever created for it, so nothing is sent. You can edit it and schedule it again.
`queued`	Becomes `canceled`, and is terminal. Addresses not yet handed over receive nothing; mail already sent cannot be recalled.

Cancelling is refused on draft, sent, canceled and expansion_incomplete.

A cancelled broadcast's undelivered remainder is not charged against your quota.

Path Parameters

broadcast_idstringrequired

The ID of the broadcast to cancel.

Response Fields

objectstring

Always "broadcast".

idstring

The broadcast ID.

statusstring

The status the broadcast is now in — "draft" if it was scheduled, "canceled" if it was mid-delivery.

curl -X POST 'https://api.postflare.app/broadcasts/d4e5f6a7-b8c9-0123-defa-234567890123/cancel' \
  -H 'Authorization: Bearer re_xxxxxxxxx'

const response = await fetch(
  'https://api.postflare.app/broadcasts/d4e5f6a7-b8c9-0123-defa-234567890123/cancel',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer re_xxxxxxxxx',
    },
  }
);

const data = await response.json();

Response

{
  "object": "broadcast",
  "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "status": "canceled"
}