Campaigns API
11 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/campaigns/ |
List Campaigns Query: status, type, search, limit, offset. |
POST |
/api/campaigns/ |
Create Campaign Accepts a JSON body. |
GET |
/api/campaigns/types |
Get Campaign Types |
GET |
/api/campaigns/{campaign_id} |
Get Campaign |
PATCH |
/api/campaigns/{campaign_id} |
Update Campaign Accepts a JSON body. |
DELETE |
/api/campaigns/{campaign_id} |
Delete Campaign |
GET |
/api/campaigns/{campaign_id}/contacts |
Get Campaign Contacts |
GET |
/api/campaigns/{campaign_id}/kpis |
Get Campaign Kpis |
GET |
/api/campaigns/{campaign_id}/leads |
Get Campaign Leads |
GET |
/api/campaigns/{campaign_id}/members |
Get Campaign Members |
GET |
/api/campaigns/{campaign_id}/opps |
Get Campaign Opportunities |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.