Skip to main content
POST
Add people to a list

Authorizations

Authorization
string
header
required

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

Path Parameters

listId
string
required

The list's id.

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

Body

application/json
personIds
string[]
required

People's ids, at most 5,000: the id of their rows in another list, or the personIds an upload answered with.

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

Response

How many people were sent, and how many of them were not in the list before.

submittedCount
integer
required
addedCount
integer
required

People new to the list. Those already in it are skipped.