Broadcasts
More ways to use this page
Get a broadcast
GET/v1/
TypeScript sendora
Python sendora
Key sk_… a server key
The broadcast and how far it has come: its status and the counts of messages released and failed.
Parameters
idin pathstring (uuid)requiredThe broadcast id.
Responses
200A broadcast and how far it has come.
broadcastIdstring (uuid)requiredstreamIdstring (uuid)requiredThe broadcast stream the messages go on.
status"accepted" | "processing" | "completed" | "cancelled"requiredaccepted until the first message leaves, processing while messages are leaving, completed when every message has left or failed, cancelled once cancelled.
fromstringrequiredsubjectstringrequiredtagstring or nullrequiredmetadatamap of string to stringrequiredtotalintegerrequiredMessages stored, after suppressed addresses were dropped.
releasedintegerrequiredMessages handed to the mail server so far.
failedintegerrequiredMessages that could not be handed over, cancelled ones included.
suppressedintegerrequiredAddresses dropped from the list for standing on the stream’s suppression list.
submittedAtstring (date-time)requiredcompletedAtstring (date-time) or nullrequiredSet once nothing is left to send, or on cancel.
Example
{
"broadcastId": "2f1c8a4e-3b6d-4f0a-9c21-7d5e6a8b9c01",
"streamId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"status": "processing",
"from": "news@acme.se",
"subject": "News from Acme in October",
"tag": "newsletter-2026-10",
"metadata": {},
"total": 2,
"released": 1,
"failed": 0,
"suppressed": 0,
"submittedAt": "2026-10-01T08:00:00.000Z",
"completedAt": null
}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.
| Code | Status | Meaning |
|---|---|---|
unauthorized | 401 | The key is missing, malformed or revoked. |
wrong_ | 403 | The 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_ | 404 | No such broadcast of this server. |