Skip to content

Update Find People Config

PUT
/enrichment/find-people/{config_id}

Edit a people-search configuration. Free in itself.

Omitted fields are left alone. Setting auto_import true here has the same consequence it has at creation: results stop waiting for a human.

Authorizations

Parameters

Path Parameters

config_id
required

Configuration id (UUID).

string

Configuration id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Edit a people-search configuration. Omitted fields are unchanged.

object
auto_import
Any of:
boolean
column_mappings
Any of:
Array<object>

Map a search result field onto a destination column.

object
source_field
required
string
target_column
required
string
company_identifier_column
Any of:
string
destination_list_id
Any of:
integer
is_active
Any of:
boolean
max_people_per_company
Any of:
integer
>= 1 <= 50
max_total_people
Any of:
integer
>= 1
name
Any of:
string
search_filters
Any of:
Array<object>

One people-search condition.

object
field
required
string
operator
required
string
value
Array
skip_across_companies
Any of:
boolean
skip_existing_in_destination
Any of:
boolean

Responses

200

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