Skip to main content
POST
Add a list to a campaign

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

campaignId
string
required

The campaign's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Body

application/json
listId
string
required

One of your people lists.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
Example:

"6a1f0c2b9d4e8a7f3c5b2e20"

Response

The campaign's lists, and whether enrolling the new list's people started.

id
string
required

The campaign.

listIds
string[]
required
alreadyPresent
boolean
required

The campaign had the list already.

enrollmentStarted
boolean
required

The campaign is running, so the list's people are being enrolled.