Send a broadcast
POST
/broadcasts/{id}/sendAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
idstring<uuid>obrigatórioCorpo da requisição
application/jsonscheduled_atstringDeliver later: ISO 8601 with offset or relative like "in 1 hour"; omitted sends now
Respostas
200
Broadcast scheduled; finishes_at and warning say when it goes out
idstring<uuid>obrigatóriofinishes_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
Valores permitidos:
truewarningobjectMostrar propriedadesOcultar propriedades
codestringobrigatóriopaced: more than the capacity available now; queued_behind: other sends go first
Valores permitidos:
pacedqueued_behinddaysintegerobrigatórioDays the send spans
messagestringobrigatório400
Not a draft
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório403
Sending paused, or a From on the shared inbox domain
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório