Skip to main content
POST
Create an exclusion list

Authorizations

X-API-Key
string
header
required

Body

application/json
kind
enum<string>
required

What an exclusion list holds.

COMPANIES is a pasted set of company names and domains, matched against a contact's account key. AUDIENCE is a live reference to a table (optionally through a saved view): rows added to that table later are excluded too, with nothing to re-save.

Available options:
companies,
audience
name
string
required
Required string length: 1 - 120
email_column_id
string<uuid> | null

Which column carries the address. Guessed from the table when omitted.

table_id
string<uuid> | null

The excluded table. Required for an audience list.

view_id
string<uuid> | null

Response

Successful Response

created_at
string<date-time>
required
email_column_id
string<uuid> | null
required
entry_count
integer
required

Pasted company names and domains on this list.

id
string<uuid>
required
kind
enum<string>
required

What an exclusion list holds.

COMPANIES is a pasted set of company names and domains, matched against a contact's account key. AUDIENCE is a live reference to a table (optionally through a saved view): rows added to that table later are excluded too, with nothing to re-save.

Available options:
companies,
audience
name
string
required
refreshed_at
string<date-time> | null
required
resolved_count
integer
required

Addresses an audience list currently resolves to.

table_id
string<uuid> | null
required
view_id
string<uuid> | null
required