Skip to main content
POST
Create a broadcast

Authorizations

Authorization
string
header
required

Tenant API key.

Body

application/json
name
string
required
phoneNumberId
string
required

An active phone of the tenant.

Pattern: ^\d+$
templateName
string
required

Must be cached and APPROVED; run a sync first.

Required string length: 1 - 512
templateLanguage
string
required
Required string length: 2 - 16
recipients
string[]
required

Numbers without +; a leading + is stripped and duplicates are removed.

Required array length: 1 - 500 elements
Pattern: ^\d{6,20}$
templateComponents
object[]

Parameters sent to every recipient.

Maximum array length: 10

Response

Draft created.

broadcast
object
required