Send a broadcast
POST
/broadcasts/{id}/sendAutorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Pfadparameter
idstring<uuid>erforderlichRequest-Body
application/jsonscheduled_atstringDeliver later: ISO 8601 with offset or relative like "in 1 hour"; omitted sends now
Antworten
200
Broadcast scheduled; finishes_at and warning say when it goes out
idstring<uuid>erforderlichfinishes_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
Erlaubt:
truewarningobjectEigenschaften anzeigenEigenschaften ausblenden
codestringerforderlichpaced: more than the capacity available now; queued_behind: other sends go first
Erlaubt:
pacedqueued_behinddaysintegererforderlichDays the send spans
messagestringerforderlich400
Not a draft
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich403
Sending paused, or a From on the shared inbox domain
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich404
Not found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich422
Validation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich