List broadcasts
Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.
/broadcastsAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
limitintegerPage size, 1-100 (default 20)
afterstring<uuid>Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.
beforestring<uuid>Cursor: id of the first item of the current page; returns the previous page; same rule as after.
Broadcasts
objectstringobrigatóriolistdataobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectidstring<uuid>obrigatórionamestring | nullobrigatóriosegment_idstring<uuid> | nullobrigatóriostatusstringobrigatóriodraft, 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_atstringobrigatórioscheduled_atstring | nullobrigatóriosent_atstring | nullobrigatóriofailure_reasonstring | nullobrigatórioBillionSend 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 | nullobrigatórioBillionSend extension: when the broadcast failed; null unless status is failed
sent_countinteger | nullobrigatórioEmails handed off so far; null before the send starts and once its emails have left the retention window
finishes_atstring | nullobrigatórioEstimated instant the last email goes out, while the broadcast is going out; else null
has_morebooleanobrigatórioMissing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioValidation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório