Campaign

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

Method	Endpoint	Description
POST	`/api/v2/campaigns`	Create campaign
GET	`/api/v2/campaigns`	List 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}/activate`	Activate(start), or resume a campaign
POST	`/api/v2/campaigns/{id}/pause`	Stop(or pause) a campaign
GET	`/api/v2/campaigns/search-by-contact`	Search campaigns by lead email
POST	`/api/v2/campaigns/{id}/share`	Share a campaign
POST	`/api/v2/campaigns/{id}/from-export`	Create campaign from shared one
POST	`/api/v2/campaigns/{id}/export`	Export campaign to JSON format
POST	`/api/v2/campaigns/{id}/duplicate`	Duplicate campaign
GET	`/api/v2/campaigns/count-launched`	Get launched campaigns count
POST	`/api/v2/campaigns/{id}/variables`	Add campaign variables
GET	`/api/v2/campaigns/{id}/sending-status`	Get campaign sending status

Overview

Getting Started

Guides

Resources

Schemas

Endpoints

​Related schemas

​Endpoints

Related schemas

Endpoints