Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Send a broadcast

POST/broadcasts/{id}/send
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstring<uuid>obrigatório
Corpo da requisição
application/json
scheduled_atstring

Deliver 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ório
finishes_atstring | null

When the last email is expected to go out (ISO 8601); null when unknown

estimatedboolean

finishes_at is an estimate that moves as other sends come in

Valores permitidos:true
warningobject
Mostrar propriedades
codestringobrigatório

paced: more than the capacity available now; queued_behind: other sends go first

Valores permitidos:pacedqueued_behind
daysintegerobrigatório

Days the send spans

messagestringobrigatório
400

Not a draft

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Sending paused, or a From on the shared inbox domain

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Corpoapplication/json
Requisição
curl -X POST 'https://api.billionsend.com/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "scheduled_at": "string"
}'
Resposta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "finishes_at": "string",
  "estimated": true,
  "warning": {
    "code": "paced",
    "days": 0,
    "message": "string"
  }
}

Esta página foi útil?