Campaigns
Email outreach end to end: create a campaign, write the sequence, enroll a list, attach mailboxes, launch. Everything the app can do, the API can do.
Email outreach end to end: create a campaign, write the sequence, enroll a list, attach mailboxes, launch. Everything the app can do, the API can do.
| 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} |
| Write the emails | POST | /api/v1/campaigns/{campaign_id}/emails |
| Add leads | POST | /api/v1/campaigns/{campaign_id}/leads |
| List enrolled leads | GET | /api/v1/campaigns/{campaign_id}/leads |
| Choose the sending mailboxes | POST | /api/v1/campaigns/{campaign_id}/senders |
| Launch | POST | /api/v1/campaigns/{campaign_id}/launch |
| Pause or stop | POST | /api/v1/campaigns/{campaign_id}/pause |
| Remove a lead | DELETE | /api/v1/campaigns/{campaign_id}/leads/{email} |
| Replies to a campaign | GET | /api/v1/campaigns/{campaign_id}/replies |
| Remove a sender | DELETE | /api/v1/campaigns/{campaign_id}/senders/{email} |
| Campaign analytics | GET | /api/v1/campaigns/{campaign_id}/analytics |
| Block an address or domain | POST | /api/v1/blocklist |
| Blocklist | GET | /api/v1/blocklist |
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.