Create a campaign

Create a campaign with its steps, lead source lists and senders. A campaign is the outreach half of an agent (campaigns are called agents in the app): create the list first (POST /api/v1/lists), then the source agent that fills it with leads (POST /api/v1/agents), then this campaign to reach out to them.

The campaign reaches out to the contacts of its own lead list (list_id, created with it) and of the lists in list_ids; lists are typically filled by a source agent or by importing contacts. Without steps it gets the default sequence for its channel (invitation, then three messages; plus two emails for multi/email when a mailbox is set). LinkedIn steps are sent from the accounts in linkedin_account_ids, email steps from the mailboxes in email_account_ids; contacts are spread across them (a contact keeps the same account and mailbox for its whole sequence, and contacts of one company share them). The single linkedin_account_id / email_account_id is still accepted (one sender); when both forms are sent the array wins, and an empty array or null removes the senders. Removing a sender hands its contacts that have not started over to the others. 1st-degree connections are excluded by default (exclude_first_degree).

It starts inactive unless active is true, which needs a LinkedIn or email sender; it can be turned on later with PATCH /api/v1/campaigns/{id}/status. Once activated, the campaign runs the outreach automatically, within the senders' daily limits and working hours. Needs the campaigns:write scope.

Steps. steps is the whole sequence in order. email steps go on the email track, every other type on the LinkedIn track; the two tracks run side by side for each contact. Waits are delay steps (delay_days; set track when the next step does not tell), or delay_days on any other step, which adds a wait before it. ai: true (the default) lets the agent write the step for each contact, with your text as the fallback; ai: false sends your text as written (message for messages and InMails, email_body and a first email_subject for emails). voice steps need a recording made in the app: send the id of an existing voice step to keep it.