Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Send a broadcast

POST/broadcasts/{id}/send
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
idstring<uuid>obligatorio
Cuerpo de la solicitud
application/json
scheduled_atstring

Deliver later: ISO 8601 with offset or relative like "in 1 hour"; omitted sends now

Respuestas
200

Broadcast scheduled; finishes_at and warning say when it goes out

idstring<uuid>obligatorio
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 propiedades
codestringobligatorio

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

Valores permitidos:pacedqueued_behind
daysintegerobligatorio

Days the send spans

messagestringobligatorio
400

Not a draft

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Sending paused, or a From on the shared inbox domain

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Cuerpoapplication/json
Solicitud
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"
}'
Respuesta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "finishes_at": "string",
  "estimated": true,
  "warning": {
    "code": "paced",
    "days": 0,
    "message": "string"
  }
}

¿Te ha resultado útil esta página?