Create a campaign
Creates a draft campaign that writes to the people on up to 10 of your people lists (listIds). A manual campaign (the default) is ready at once, with one empty step for each of its channels (email when left out): write them with PATCH /v1/campaigns/{campaignId}/steps/{stepId}. An ai-generated campaign has its steps written from prompt in the background: read it with GET /v1/campaigns/{campaignId} until initializationStatus is completed or failed. A templateId copies a saved template’s steps, which decide the channels.
Nothing is sent until you launch it with POST /v1/campaigns/{campaignId}/launch. Messages go out from 9:00 to 17:00 in timezone (UTC when left out) on emailDays (Monday to Friday when left out). Open and click tracking are off unless you turn them on; with click tracking on, links go through your tracking domain once it is active (GET /v1/tracking-domains).
A list, template, writing style or knowledge hub the organization does not have answers 404 with its own code, such as list_not_found. Lists with nobody the channels can reach (no work email for email steps, no LinkedIn profile for LinkedIn steps) answer 422 list_incompatible_with_channels.
Free. Scope: campaigns, with a key that can write.
Authorizations
Body
One empty step is made for each channel, in order: email, linkedin_connection (an invitation), linkedin_message (to a connection) or inmail. ["email"] when left out. At most one linkedin_connection, before every linkedin_message. Not with templateId.
1 - 10 elementsemail, linkedin_connection, linkedin_message, inmail