Skip to main content
A campaign is built from contact lists, contact tags and/or extra numbers. Repeated numbers are removed, and people who opted out are left out when it’s sent. Sending happens in the background, paced by Messaly.
1

Create the campaign

It’s saved as a draft. The response gives its id and totalRecipients.
2

Send it, or schedule it

If your wallet doesn’t cover the campaign, sending returns 402 INSUFFICIENT_BALANCE. If everyone in it has opted out, it returns 400 ALL_OPTED_OUT.
3

Follow its progress

Call GET /sms/campaigns/{id} for totals and delivery rate, and GET /sms/campaigns/{id}/recipients for each person. Or wait for the campaign.completed webhook.

Personalisation

Use these placeholders in message. Each one is filled in from the contact:

Campaign status