Production Ready1 min read
Campaigns
Draft, edit, schedule, send, cancel — with engagement stats.
Module:dashboard/campaigns/introduction
Campaigns (broadcast email)#
Campaigns let you draft, schedule, and send list-based broadcasts with unsubscribe support and engagement stats.
Sending auth: create an API key in the dashboard (API keys), then use Authorization: Bearer eg_... or X-API-Key. Do not use a dashboard JWT for create/send/schedule.
Core endpoints#
GET/POST /api/v1/campaigns(list/create)GET /api/v1/campaigns/:id(read)PATCH /api/v1/campaigns/:id(edit draft/scheduled)POST /api/v1/campaigns/:id/schedule(schedule)POST /api/v1/campaigns/:id/send(send now)POST /api/v1/campaigns/:id/cancel(cancel)
Unsubscribe support#
Campaign emails include:
- Unsubscribe footer
- List-Unsubscribe header
Unsubscribes auto-suppress future sends to that recipient.
Stats and logs#
Campaign delivery + engagement is available via:
GET /api/v1/campaigns/:id/stats- Message history filtered by
campaignId
Related Documentation
Explore interconnected guides and API endpoints.
Have a question about this guide?
Contact our engineering and deliverability support team anytime.