跳到内容
Esc
↑↓导航↵打开⌘J预览

Send a broadcast

POST/broadcasts/{id}/send
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
idstring<uuid>必填
请求体
application/json
scheduled_atstring

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

响应
200

Broadcast scheduled; finishes_at and warning say when it goes out

idstring<uuid>必填
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

允许值:true
warningobject
显示属性
codestring必填

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

允许值:pacedqueued_behind
daysinteger必填

Days the send spans

messagestring必填
400

Not a draft

statusCodenumber必填
namestring必填
messagestring必填
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Sending paused, or a From on the shared inbox domain

statusCodenumber必填
namestring必填
messagestring必填
404

Not found

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求体application/json
请求
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"
}'
响应
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "finishes_at": "string",
  "estimated": true,
  "warning": {
    "code": "paced",
    "days": 0,
    "message": "string"
  }
}

这个页面有帮助吗?