Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Send a broadcast

POST/broadcasts/{id}/send
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstring<uuid>required
Request body
application/json
scheduled_atstring

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

Responses
200

Broadcast scheduled; finishes_at and warning say when it goes out

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

Allowed:true
warningobject
Show properties
codestringrequired

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

Allowed:pacedqueued_behind
daysintegerrequired

Days the send spans

messagestringrequired
400

Not a draft

statusCodenumberrequired
namestringrequired
messagestringrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Sending paused, or a From on the shared inbox domain

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
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"
}'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "finishes_at": "string",
  "estimated": true,
  "warning": {
    "code": "paced",
    "days": 0,
    "message": "string"
  }
}

Was this page helpful?