Skip to content

Create Auto Enrichment Config

POST
/enrichment/auto-enrichment/configs

Enrich every record that lands on a list. ARMS ONGOING SPEND.

From now on each record added to audience_id is enriched by the waterfall or AI group column_id, and charged, with no further call. Needs write access to the list; the column must already be available on it. Turn it off with PATCH or DELETE /enrichment/auto-enrichment/configs/{config_id}.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Enrich every record that lands on a list. ARMS ONGOING SPEND.

object
audience_id
required

The list.

integer
> 0
column_id
required

The waterfall column or AI group id.

string
>= 1 characters <= 255 characters
enrichment_type
required
string
Allowed values: waterfall ai
trigger_on_insert
boolean
default: true

Responses

201

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string