Campaigns
Email outreach from start to finish. Create a campaign, write the emails, add people, choose the sending mailboxes and launch. Nothing sends until you launch.
Email outreach from start to finish. Create a campaign, write the emails, add people, choose the sending mailboxes and launch. Nothing sends until you launch.
| Operation | Method | Path |
|---|---|---|
| Create a campaign | POST | /api/v1/campaigns |
| List campaigns | GET | /api/v1/campaigns |
| Delete a campaign | DELETE | /api/v1/campaigns/{campaign_id} |
| Get a campaign | GET | /api/v1/campaigns/{campaign_id} |
| Update campaign settings | PATCH | /api/v1/campaigns/{campaign_id} |
| Duplicate a campaign | POST | /api/v1/campaigns/{campaign_id}/duplicate |
| Write the emails | POST | /api/v1/campaigns/{campaign_id}/emails |
| Add people | POST | /api/v1/campaigns/{campaign_id}/leads |
| List the people in a campaign | GET | /api/v1/campaigns/{campaign_id}/leads |
| Remove a person | DELETE | /api/v1/campaigns/{campaign_id}/leads/{email} |
| Remove many people | POST | /api/v1/campaigns/{campaign_id}/leads/remove |
| Bring people back | POST | /api/v1/campaigns/{campaign_id}/leads/restore |
| Move people to another campaign | POST | /api/v1/campaigns/{campaign_id}/leads/move |
| Background jobs for people | GET | /api/v1/campaigns/{campaign_id}/lead-jobs |
| One background job | GET | /api/v1/campaigns/{campaign_id}/lead-jobs/{job_id} |
| Write personal lines | PATCH | /api/v1/campaigns/{campaign_id}/leads/custom-fields |
| Personal lines from a file | POST | /api/v1/campaigns/{campaign_id}/leads/custom-fields/import |
| Personal lines file status | GET | /api/v1/campaigns/{campaign_id}/leads/custom-fields/import/{job_id} |
| Read the personal lines | GET | /api/v1/campaigns/{campaign_id}/personalization |
| Set up personal lines | PUT | /api/v1/campaigns/{campaign_id}/personalization |
| List a campaign's senders | GET | /api/v1/campaigns/{campaign_id}/senders |
| Choose the sending mailboxes | POST | /api/v1/campaigns/{campaign_id}/senders |
| Send a test email | POST | /api/v1/campaigns/{campaign_id}/test-email |
| Create a folder | POST | /api/v1/folders |
| List folders | GET | /api/v1/folders |
| Rename a folder | PATCH | /api/v1/folders/{folder_id} |
| List campaign tags | GET | /api/v1/campaign-tags |
| Tag campaigns | POST | /api/v1/campaign-tags |
| Move a campaign to a folder | POST | /api/v1/campaigns/{campaign_id}/folder |
| Remove a sending mailbox | DELETE | /api/v1/campaigns/{campaign_id}/senders/{email} |
| Launch | POST | /api/v1/campaigns/{campaign_id}/launch |
| Pause | POST | /api/v1/campaigns/{campaign_id}/pause |
| Stop | POST | /api/v1/campaigns/{campaign_id}/stop |
| Campaign results | GET | /api/v1/campaigns/{campaign_id}/analytics |
| Replies to a campaign | GET | /api/v1/campaigns/{campaign_id}/replies |
| Follow-up sequences | GET | /api/v1/campaigns/{campaign_id}/subsequences |
| Set follow-up sequences (POST) | POST | /api/v1/campaigns/{campaign_id}/subsequences |
| Set follow-up sequences | PUT | /api/v1/campaigns/{campaign_id}/subsequences |
| Turn a follow-up sequence off or on | PATCH | /api/v1/campaigns/{campaign_id}/subsequences/{subsequence_id} |
Every page below is generated from the OpenAPI document and carries a request sample in the language you pick. The playground sends to production with your own key.