Skip to main content
POST
Create broadcast

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Body

application/json
segmentId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
segmentKey
string
Required string length: 1 - 120
from
string

Sender email address. Friendly names may use "Name sender@example.com".

Required string length: 1 - 320
subject
string
Required string length: 1 - 998
replyTo
Pattern: ^(?:[A-Za-z0-9_'+-]+\.)*[A-Za-z0-9_'+-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9-]*\.)+[A-Za-z]{2,}$
html
string
Minimum string length: 1
text
string
name
string
Required string length: 1 - 200
topicId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
subscriptionGroupId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
templateId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
templateKey
string
Required string length: 1 - 120
send
boolean
default:false
scheduledAt
string

When to send. An ISO 8601 datetime with an explicit offset, such as "2026-10-25T09:00:00+03:00" or "2026-10-25T06:00:00Z", or a relative time: "in N minutes", "in N hours", or "in N days". Days keep the local clock time in the Organization's Campaign calendar timezone (UTC when none is set).

Minimum string length: 1

Response

Default Response

id
string<uuid>
required

Broadcast id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$