API Reference/Campaigns

Campaigns API

Create, run, and manage outbound campaigns — including their leads, schedule, and templates.

20 endpointsAuth: API key
POST
/v1/campaigns/
Create a campaign
scope: writePOST
/v1/campaigns/launch
Launch a campaign
scope: writeGET
/v1/campaigns/
List campaigns
scope: readGET
/v1/campaigns/:id
Get campaign
scope: readGET
/v1/campaigns/:id/stats
Get campaign stats
scope: readGET
/v1/campaigns/:id/analytics
Get campaign analytics
scope: readGET
/v1/campaigns/:id/activity
Get campaign activity
scope: readGET
/v1/campaigns/summary
Get account summary
scope: readGET
/v1/campaigns/activity
Get account activity
scope: readGET
/v1/campaigns/:id/leads
List campaign leads
scope: readPOST
/v1/campaigns/:id/leads
Add campaign leads
scope: writeGET
/v1/campaigns/:id/leads/:leadId/thread
Get lead thread
scope: readGET
/v1/campaigns/:id/leads/:leadId/meeting
Get lead meeting
scope: readPOST
/v1/campaigns/:id/leads/:leadId/send-now
Send now
scope: writeGET
/v1/campaigns/:id/followup-status
Get follow-up status
scope: readPOST
/v1/campaigns/:id/start
Start campaign
scope: writePOST
/v1/campaigns/:id/pause
Pause campaign
scope: writePOST
/v1/campaigns/:id/resume
Resume campaign
scope: writeDELETE
/v1/campaigns/:id
Delete campaign
scope: writePOST
/v1/campaigns/bulk-delete
Bulk delete campaigns
scope: write