Retrieve a broadcast
/broadcasts/{id}AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
idstring<uuid>requiredBroadcast
idstring<uuid>requirednamestring | nullrequiredsegment_idstring<uuid> | nullrequiredstatusstringrequireddraft, 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_atstringrequiredscheduled_atstring | nullrequiredsent_atstring | nullrequiredfailure_reasonstring | nullrequiredBillionSend 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
domain_missingsender_domain_mismatchtopic_other_domainsegment_other_domaindomain_unverifiedretries_exhaustednullfailed_atstring | nullrequiredBillionSend extension: when the broadcast failed; null unless status is failed
sent_countinteger | nullrequiredEmails handed off so far; null before the send starts and once its emails have left the retention window
finishes_atstring | nullrequiredEstimated instant the last email goes out, while the broadcast is going out; else null
objectstringrequiredbroadcastfromstringrequiredsubjectstringrequiredreply_tostring[] | nullrequiredpreview_textstring | nullrequiredtopic_idstring<uuid> | nullrequireddomain_idstring<uuid> | nullrequiredBillionSend 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 | nullrequiredtextstring | nullrequiredMissing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired