Hoppa till innehållet

Menu

Broadcasts

More ways to use this page

Cancel a broadcast

POST/v1/broadcasts/{id}/cancel

TypeScript sendora.broadcasts.cancel(broadcastId)

Python sendora.broadcasts.cancel(broadcast_id)

Key sk_… a server key

Holds every message of the broadcast that has not been handed to the mail server yet; those count as failed. A message already on its way is delivered. A completed or cancelled broadcast answers 409.

Parameters

  • idin pathstring (uuid)required

    The broadcast id.

Responses

200A broadcast and how far it has come.

  • broadcastIdstring (uuid)required
  • streamIdstring (uuid)required

    The broadcast stream the messages go on.

  • status"accepted" | "processing" | "completed" | "cancelled"required

    accepted until the first message leaves, processing while messages are leaving, completed when every message has left or failed, cancelled once cancelled.

  • fromstringrequired
  • subjectstringrequired
  • tagstring or nullrequired
  • metadatamap of string to stringrequired
  • totalintegerrequired

    Messages stored, after suppressed addresses were dropped.

  • releasedintegerrequired

    Messages handed to the mail server so far.

  • failedintegerrequired

    Messages that could not be handed over, cancelled ones included.

  • suppressedintegerrequired

    Addresses dropped from the list for standing on the stream’s suppression list.

  • submittedAtstring (date-time)required
  • completedAtstring (date-time) or nullrequired

    Set once nothing is left to send, or on cancel.

Example

{
  "broadcastId": "2f1c8a4e-3b6d-4f0a-9c21-7d5e6a8b9c01",
  "streamId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "cancelled",
  "from": "news@acme.se",
  "subject": "News from Acme in October",
  "tag": "newsletter-2026-10",
  "metadata": {},
  "total": 2,
  "released": 1,
  "failed": 1,
  "suppressed": 0,
  "submittedAt": "2026-10-01T08:00:00.000Z",
  "completedAt": "2026-10-01T08:05:00.000Z"
}

Errors

Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.

CodeStatusMeaning
unauthorized401The key is missing, malformed or revoked.
wrong_token_kind403The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes.
not_found404No such broadcast of this server.
broadcast_not_open409The broadcast is completed or cancelled already; nothing is left to cancel.