Skip to main content
POST
Send broadcast

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Path Parameters

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Broadcast sent

success
boolean
required
queued
integer
required

Number of emails successfully queued for sending

total
integer
required

Total number of eligible recipients after filtering

excluded
integer
required

Count of contacts excluded due to unsubscriptions (global or topic-specific)

status
string
required

Current status of the broadcast send operation

Example:

"queued"