/broadcasts

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Internal name shown in the dashboard

segment_id?string

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

Formatuuid

from*string

Sender, "Name user@domain"; the domain must be verified for the team

subject*string

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

Length1 <= length

html?string

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

text?string

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

reply_to?|array<string>

Reply-To address or list

preview_text?string

Inbox preview (preheader) text

topic_id?string

Topic id; only contacts subscribed to it receive the broadcast

Formatuuid

send?boolean

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

scheduled_at?string

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

Response Body

`application/json`

curl -X POST "https://example.com/broadcasts" \  -H "Content-Type: application/json" \  -d '{    "from": "string",    "subject": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "finishes_at": "string",  "estimated": true,  "warning": {    "code": "paced",    "days": 0,    "message": "string"  }}

/broadcasts

Request Body

Response Body

200application/json

400application/json

403application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`