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

Create a broadcast

POST/broadcasts
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Cuerpo de la solicitud
obligatorioapplication/json
namestring

Internal name shown in the dashboard

segment_idstring<uuid>

Segment to send to; omitted means every contact of the team

fromstringobligatorio

Sender, "Name <user@domain>"; the domain must be one of the team's own verified domains when the broadcast is sent: sending from an address on the shared inbox domain answers 403

subjectstringobligatorio

Subject line; supports {{{FIRST_NAME|there}}} merge fields

longitud mín. 1 · longitud máx. 998
htmlstring

HTML body; include {{{UNSUBSCRIBE_URL}}} for the opt-out link

textstring

Plain-text body; at least one of html/text is required

reply_tostring | string[]

Reply-To address or list

Mostrar propiedades
Al menos uno de:
string
string
string[]
Array de string
string
preview_textstring

Inbox preview (preheader) text

topic_idstring<uuid> | null

Topic id; only contacts subscribed to it receive the broadcast

sendboolean

true sends (or schedules) immediately instead of saving a draft

scheduled_atstring

Deliver later (requires send: true): ISO 8601 with offset or relative like "in 1 hour"

Respuestas
200

Broadcast created (and scheduled when send: true)

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

Broadcast state conflict

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key, 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
Cuerpoapplication/json
Solicitud
curl -X POST 'https://api.billionsend.com/broadcasts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "segment_id": "0dbbf761-5b2d-4647-8bfa-2b714456749c",
  "from": "string",
  "subject": "string",
  "html": "string",
  "text": "string",
  "reply_to": "string",
  "preview_text": "string",
  "topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",
  "send": true,
  "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?