Create a broadcast

POST/broadcasts

Resend-compatible. segment_id (or audience_id) is a list or a filter segment; send: true creates and sends (or schedules) in one step: a refused send creates nothing. Honours Idempotency-Key (24 hours).

Authorization

apiKey

AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 256

segment_id?|

audience_id?string

Stamp0 lst_ identifier

Match^lst_[0-9A-Za-z]{16}$

topic_id?string

Stamp0 lst_ identifier

Match^lst_[0-9A-Za-z]{16}$

from*string

Lengthlength <= 320

subject*string

Lengthlength <= 998

reply_to?|array<>

preview_text?string

Lengthlength <= 512

html?string

Length1 <= length

text?string

Length1 <= length

send?boolean

scheduled_at?string

Length1 <= length <= 100

Response Body

`application/json`

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

{  "id": "string"}

Create a broadcast

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`