Create a broadcast
/broadcastsAuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
application/jsonnamestringInternal name shown in the dashboard
segment_idstring<uuid>Segment to send to; omitted means every contact of the team
fromstringobligatorioSender, "Name <user@domain>"; the domain must be one of the team's own verified domains when the broadcast is sent: sending from an address on the shared inbox domain answers 403
subjectstringobligatorioSubject line; supports {{{FIRST_NAME|there}}} merge fields
htmlstringHTML body; include {{{UNSUBSCRIBE_URL}}} for the opt-out link
textstringPlain-text body; at least one of html/text is required
reply_tostring | string[]Reply-To address or list
Mostrar propiedadesOcultar propiedades
stringstringstringpreview_textstringInbox preview (preheader) text
topic_idstring<uuid> | nullTopic id; only contacts subscribed to it receive the broadcast
sendbooleantrue sends (or schedules) immediately instead of saving a draft
scheduled_atstringDeliver later (requires send: true): ISO 8601 with offset or relative like "in 1 hour"
Broadcast created (and scheduled when send: true)
idstring<uuid>obligatoriofinishes_atstring | nullWhen the last email is expected to go out (ISO 8601); null when unknown
estimatedbooleanfinishes_at is an estimate that moves as other sends come in
truewarningobjectMostrar propiedadesOcultar propiedades
codestringobligatoriopaced: more than the capacity available now; queued_behind: other sends go first
pacedqueued_behinddaysintegerobligatorioDays the send spans
messagestringobligatorioBroadcast state conflict
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioMissing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioRestricted API key, sending paused, or a From on the shared inbox domain
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioNot found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioValidation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio