Campaigns

Create and manage your campaigns (multichannel: email + LinkedIn), and retrieve their details, attached lists, activities, manual tasks and statistics. Campaign contacts are managed through the lists attached to the campaign — see the Lists section.

📄️ Create a campaign

Create a campaign

📄️ List campaigns

List campaigns

📄️ Get campaign details

Retrieve the full configuration of a campaign. The response includes the contact lists attached to the campaign (`recipients.lists`) and the lists excluded from it (`recipients.excludedLists`), each with its ID, name and number of contacts.

📄️ Delete a campaign

Permanently delete a campaign. The contacts and the contact lists attached to it are not deleted, and stay available for your other campaigns.

📄️ Rename a campaign

Change the name of a campaign.

📄️ Update campaign settings

Update the general settings of a campaign: daily cadence, sending window, tracking, and the events that stop the sequence for a contact.

📄️ Update campaign contact lists

Attach one or several contact lists to a campaign, and optionally exclude lists from it.

📄️ Update campaign identities

Set the identities of a campaign. An identity is a sender: a name, and the accounts it sends from — an email provider and/or a LinkedIn account.

📄️ Schedule a campaign start

Plan the automatic start of a campaign at a given date, or cancel the plan already registered.

📄️ Start a campaign

Start a campaign and schedule its first actions.

📄️ Pause a campaign

Pause a running campaign and cancel every action already scheduled. The campaign must be `RUNNING`.

📄️ Duplicate a campaign

Create a new campaign from an existing one. You choose what is copied; everything not copied keeps the default values of a new campaign.

📄️ Archive a campaign

Archive a campaign: its status becomes `ARCHIVED` and it is no longer returned by **List campaigns**. Its contacts, activities and statistics are kept.

📄️ Get campaign activities

Get campaign activities

📄️ Get pending manual tasks for a campaign

Returns the list of pending manual tasks for a given campaign. Optionally filter by step ID.

📄️ Set a manual task status

Mark a pending manual task as completed (ok) or failed (ko) for a specific contact in a campaign.

📄️ Get campaign statistics

Get campaign statistics