Send a broadcast to an audience

Sends the same SMS or MMS to every contact matching an audience filter — your groups, tags, profile fields, custom fields or tracking-link activity — instead of an explicit recipient list. Only contacts opted in to at least one of your groups, and not opted out, are ever included.

The audience is counted when you send: a filter matching nobody is rejected with 33039, and totalRecipients in the response is that count. Every id the filter names (grp_, tag_, con_, tlk_) and every custom-field label must belong to your account, otherwise 33041.

Personalize with merge tags such as {{contact_first_name}}, and track clicks per recipient with {{trackingLink "your.domain/code"}}.

Rate limit: shares the 1 request per minute budget of POST /v1/messaging/broadcast.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
audience
object
required
string
required

Sender phone number in E.164 format or short code (5-6 digits)

string
length ≤ 640

Message body text. Required for SMS (when mediaUrl is not provided). Supports merge tags such as {{contact_first_name}} and tracking links as {{trackingLink "your.domain/code"}}.

string

Publicly accessible URL to a media file. When provided, the message is sent as MMS. Maximum file size: 1 MB.

waveConfig
object
string
length between 2 and 100

Idempotency key to prevent duplicate sends. Must be 2-100 characters long. Allowed characters: English letters (A-Z, a-z), digits (0-9), and : @ - _ ) (.

Responses

401

Unauthorized. 33001.

402

Payment Required. 33023 insufficient credits.

403

Forbidden. 33004 number not owned, 33011 sender blocked, 33020 account not configured, 33021 user not active, 33022 API not enabled.

409

Conflict. 33013 duplicate idempotency key.

429

Too Many Requests. 33002 rate limit exceeded, 33012 the audience exceeds your remaining daily quota.

500

Internal Server Error. 33000.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json