Skip to main content
POST
Exclude a list from campaigns

Authorizations

Authorization
string
header
required

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

Body

application/json
listId
string
required

The people list or company list to exclude: one your organization made.

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

"6a1f0c2b9d4e8a7f3c5b2e24"

Response

The new exclusion: campaigns skip the list's people from their next enrollment on.

id
string
required
listId
string
required

The excluded list.

listType
enum<string>
required

people: the list's people are skipped. company: everyone whose record is linked to one of the list's companies is skipped.

Available options:
people,
company
listName
string

The list's name as it is now. A deleted list keeps the name it had.

matchedPeopleCount
integer

How many checks have skipped a person because of it, in all. The same person counts once for each check, and a campaign with isDynamic checks its lists every 30 minutes.

matchedCompanyCount
integer

For a company list, how many of its companies have had a person skipped. 0 for a people list.

createdAt
string<date-time>

When the list was excluded.