Core Concepts
Campaigns
What a campaign is and how its lifecycle works.
A campaign is one outbound effort: a set of people, an email sequence, and the inboxes it sends from. Everything you do through the API hangs off a campaign.
A campaign moves through a few simple states:
| State | What it means |
|---|---|
| Draft | You are still building it. Add or change anything — steps, people, inboxes. Nothing sends yet. |
| Scheduled | Launched, but waiting for lifecycle_schedule.start_on. Nothing sends until that local date. |
| Running | It is live and sending. You can still edit email copy and timing, but not add or remove steps. |
| Paused | Sending is on hold. You can restructure the sequence again, then resume. |
| Stopped | Finished. No more sending and no more edits. |
The usual path is draft → launch → running (or scheduled, if you set a future start date), with pause and resume whenever you need to make bigger changes.
Ready to build one? Follow the Campaign setup guide. To see the exact fields, check the API Reference.
Campaigns imported from Smartlead are read-only through this API.