Skip to main content
POST
Add people 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
personIds
string[]
required

1 to 60 people, each once: the id of their rows in a list, or the ids an upload or enrichment answered with.

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

Response

What happened to each person sent.

addedCount
integer
required
activationStarted
boolean
required

The sequence started for the people added.

people
object[]
required