Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Send a broadcast

POST/broadcasts/{id}/send
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstring<uuid>requis
Corps de la requête
application/json
scheduled_atstring

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

Réponses
200

Broadcast scheduled; finishes_at and warning say when it goes out

idstring<uuid>requis
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

Valeurs autorisées :true
warningobject
Afficher les propriétés
codestringrequis

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

Valeurs autorisées :pacedqueued_behind
daysintegerrequis

Days the send spans

messagestringrequis
400

Not a draft

statusCodenumberrequis
namestringrequis
messagestringrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Sending paused, or a From on the shared inbox domain

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Corpsapplication/json
Requête
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"
}'
Réponse
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "finishes_at": "string",
  "estimated": true,
  "warning": {
    "code": "paced",
    "days": 0,
    "message": "string"
  }
}

Cette page vous a-t-elle été utile ?