Broadcast Campaigns
Use campaigns to message many contacts at once with a template or custom content, optional scheduling, and live progress tracking.Create a campaign in the dashboard
Write the message
Use a template with variables such as
{{name}}, or write custom text/media content.Use campaigns from the API
Authenticate with an API key that can manage campaigns, then call:| Action | Method | Endpoint |
|---|---|---|
| List campaigns | GET | /api/v1/campaigns |
| Create a draft | POST | /api/v1/campaigns |
| Get progress | GET | /api/v1/campaigns/{id} |
| Update a draft | PATCH | /api/v1/campaigns/{id} |
| Start sending | POST | /api/v1/campaigns/{id}/execute |
| Pause | POST | /api/v1/campaigns/{id}/pause |
| Resume | POST | /api/v1/campaigns/{id}/resume |
| Cancel | POST | /api/v1/campaigns/{id}/cancel |
SDK example
Campaigns require a plan that includes campaign access. If create or execute fails with a plan error, upgrade in Billing or use a key with the right permissions.