Outreach Campaigns

Campaigns (outreach sequences) let you send automated message sequences to a list of leads. Each campaign belongs to a workspace and progresses through a defined set of steps.

Creating and Starting a Campaign

1. Create a lead list. Use Upload CSV list or Create CRM list, then save the returned list ID.

2. Create the campaign. Call Create campaign with the list ID. The campaign is created with status: "draft", and list processing starts asynchronously.

3. Check whether duplicate resolution is required. Poll Get campaign. When duplicationResolutionNeeded is true, resolve the duplicates before starting the campaign. If the field is absent, continue to the start step; a 409 Conflict response means list processing is still running, so wait and retry.

4. Resolve duplicates when required. Call List campaign leads with stopReason=duplicate to retrieve all leads awaiting a decision. For each lead, choose keep or remove, then submit the decisions to Resolve duplicate campaign leads. Continue until duplicationResolutionNeeded is no longer present.

5. Start the campaign. Call Update campaign status with {"status":"active"}. The campaign can start only after list processing and duplicate resolution are complete.

Campaign Status

A campaign moves through the following statuses:

Deleting a Campaign

Only campaigns in draft, paused, or completed status can be deleted. Attempting to delete an active campaign returns a 409 Conflict error. Pause or complete the campaign first.

Endpoints