Skip to main content

Campaigns API

List campaigns​

GET /api/v1/campaigns

Create a campaign​

POST /api/v1/campaigns
{
  "name": "Q1 Outreach",
  "type": "connection_message",
  "lead_list_id": "list_abc123",
  "steps": [
    { "type": "connection_request", "note": "Hi {{firstName}}!" },
    { "type": "message", "delay_days": 2, "body": "Thanks for connecting!" }
  ]
}

Get campaign details​

GET /api/v1/campaigns/:id

Start / Pause a campaign​

POST /api/v1/campaigns/:id/start
POST /api/v1/campaigns/:id/pause

Campaign analytics​

GET /api/v1/campaigns/:id/analytics

Returns connection rate, reply rate, and per-step metrics.