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
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