Skip to content

Create Routing Rule

POST
/enrichment/list-routing/rules

Move records from one list to another when they match. FREE to create.

schedule_type decides how long this lives: one_time runs when asked, continuous keeps matching NEW records for as long as the rule exists. A continuous rule combined with an auto-enriching destination is a standing spend, so read the two together.

column_config.mode all copies every enrichment column with the record - data you have already paid for travels with it rather than being re-bought.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Move records from one list to another when they match.

object
ai_explanation
Any of:
string
column_config

Which columns travel with a routed record.

object
mode

‘all’ copies every column; ‘selected’ uses the list below.

string
default: all
selected_column_ids
Array<string>
static_values
object
key
additional properties
string
conditions
Array<object>

One routing condition.

object
field
required
string
operator
required
string
value
value_to
dest_list_id
Any of:
integer
dest_list_name
Any of:
string
formula_text
Any of:
string
name
required
string
schedule_type

continuous keeps matching NEW records for as long as the rule exists.

string
default: one_time
Allowed values: one_time continuous
source_list_id
required
integer
sync_mode
string
default: all_matching
Allowed values: all_matching new_only

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