Skip to main content
Manage campaigns for sending to lists of recipients. These endpoints let you create, list, update, and delete campaigns, as well as activate, pause, share, duplicate, and export them. You can also search campaigns by lead email, manage campaign variables, and check sending status.
  • Campaign — full field reference for campaign objects

​
Endpoints

MethodEndpointDescription
POST/api/v2/campaignsCreate campaign
GET/api/v2/campaignsList campaign
GET/api/v2/campaigns/{id}Get campaign
PATCH/api/v2/campaigns/{id}Patch campaign
DELETE/api/v2/campaigns/{id}Delete campaign
POST/api/v2/campaigns/{id}/activateActivate(start), or resume a campaign
POST/api/v2/campaigns/{id}/pauseStop(or pause) a campaign
GET/api/v2/campaigns/search-by-contactSearch campaigns by lead email
POST/api/v2/campaigns/{id}/shareShare a campaign
POST/api/v2/campaigns/{id}/from-exportCreate campaign from shared one
POST/api/v2/campaigns/{id}/exportExport campaign to JSON format
POST/api/v2/campaigns/{id}/duplicateDuplicate campaign
GET/api/v2/campaigns/count-launchedGet launched campaigns count
POST/api/v2/campaigns/{id}/variablesAdd campaign variables
GET/api/v2/campaigns/{id}/sending-statusGet campaign sending status