Retrieve a broadcast
/broadcasts/{id}AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
idstring<uuid>obligatorioBroadcast
idstring<uuid>obligatorionamestring | nullobligatoriosegment_idstring<uuid> | nullobligatoriostatusstringobligatoriodraft, 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_atstringobligatorioscheduled_atstring | nullobligatoriosent_atstring | nullobligatoriofailure_reasonstring | nullobligatorioBillionSend 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 | nullobligatorioBillionSend extension: when the broadcast failed; null unless status is failed
sent_countinteger | nullobligatorioEmails handed off so far; null before the send starts and once its emails have left the retention window
finishes_atstring | nullobligatorioEstimated instant the last email goes out, while the broadcast is going out; else null
objectstringobligatoriobroadcastfromstringobligatoriosubjectstringobligatorioreply_tostring[] | nullobligatoriopreview_textstring | nullobligatoriotopic_idstring<uuid> | nullobligatoriodomain_idstring<uuid> | nullobligatorioBillionSend 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 | nullobligatoriotextstring | nullobligatorioMissing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioNot found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio