Skip to main content
POST
Create / send / schedule a broadcast

Authorizations

Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Body

application/json
name
string
required
templateId
string
audienceId
string

Target audience id (required to send)

fromName
string
fromEmail
string
subject
string

Overrides the template subject. Stored with its merge tokens intact and rendered per recipient at send time, from the contact's fields.

Example:

"A gift for you, {{firstName | friend}}"

status
enum<string>
Available options:
draft,
sending
scheduledAt
string<date-time>

ISO timestamp; when set with status=sending the broadcast is scheduled

Response

200 - application/json

Created/dispatched

success
boolean
id
string
recipientCount
integer