Skip to main content
POST
Add contacts to a campaign

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Path Parameters

campaign_id
string
required

Unique identifier for a campaign.

Pattern: ^camp_[0-9a-f]{32}$
Example:

"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Body

application/json

Body for adding contacts to a campaign or an audience.

Takes ids of contacts that already exist, rather than contact details. This endpoint is not an import: creating people and messaging them should not be the same call, because the failure modes are different and only one of them is reversible.

contact_ids
string[]
required

Contacts to add. They must already exist in this workspace.

Required array length: 1 - 1000 elements

Unique identifier for a contact.

Pattern: ^con_[0-9a-f]{32}$

Response

Successful Response

What an enrolment actually did.

added
integer
required

Contacts newly enrolled. Excludes any already present.

already_present
integer
required

Contacts that were already in this campaign or audience.

object
string
default:enrolment_result
Allowed value: "enrolment_result"