Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a broadcast

GET/broadcasts/{id}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstring<uuid>required
Responses
200

Broadcast

idstring<uuid>required
namestring | nullrequired
segment_idstring<uuid> | nullrequired
statusstringrequired

draft, queued, sent, or the BillionSend extensions canceled and failed. failed: the send could not go ahead, either on a condition no retry would change or because the retries ran out; failure_reason says why. Emails already handed off stay sent.

created_atstringrequired
scheduled_atstring | nullrequired
sent_atstring | nullrequired
failure_reasonstring | nullrequired

BillionSend extension: why a failed broadcast failed (domain_missing: its sending domain was deleted; sender_domain_mismatch: from is no longer on that domain; topic_other_domain / segment_other_domain: its topic or segment is bound to another domain; domain_unverified: its sending domain was not verified through every retry; retries_exhausted: sending kept failing until the retries ran out); null unless status is failed

Allowed:domain_missingsender_domain_mismatchtopic_other_domainsegment_other_domaindomain_unverifiedretries_exhaustednull
failed_atstring | nullrequired

BillionSend extension: when the broadcast failed; null unless status is failed

sent_countinteger | nullrequired

Emails handed off so far; null before the send starts and once its emails have left the retention window

finishes_atstring | nullrequired

Estimated instant the last email goes out, while the broadcast is going out; else null

objectstringrequired
Allowed:broadcast
fromstringrequired
subjectstringrequired
reply_tostring[] | nullrequired
preview_textstring | nullrequired
topic_idstring<uuid> | nullrequired
domain_idstring<uuid> | nullrequired

BillionSend extension: the domain of yours that from is on, set whenever from is. Its opt-outs decide who is left out and its unsubscribe page opens from the links. null while from is not on a domain of yours (the broadcast is sent only once it is).

htmlstring | nullrequired
textstring | nullrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "segment_id": "0dbbf761-5b2d-4647-8bfa-2b714456749c",
  "status": "string",
  "created_at": "string",
  "scheduled_at": "string",
  "sent_at": "string",
  "failure_reason": "domain_missing",
  "failed_at": "string",
  "sent_count": 0,
  "finishes_at": "string",
  "object": "broadcast",
  "from": "string",
  "subject": "string",
  "reply_to": [
    "string"
  ],
  "preview_text": "string",
  "topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "html": "string",
  "text": "string"
}

Was this page helpful?