Skip to content

Update Enrichment Config

PUT
/enrichment/configs/{config_id}

Change fields on an enrichment configuration. Free.

Whatever keys are sent are written - the app takes a free-form body here and this forwards it unchanged rather than narrowing what the browser can already do. updated_by is stamped from the calling key and cannot be supplied. A qualification configuration shared by every list answers 409 unless scope=org (admin keys only).

Authorizations

Parameters

Path Parameters

config_id
required

Enrichment configuration id (UUID).

string

Enrichment configuration id (UUID).

Query Parameters

scope
Any of:
string
/^org$/

Set to org to change or delete a qualification group shared by every list (the ICP and Persona qualification groups). Admin keys only. Without it such a call answers 409 with code shared_qualification_group.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Fields to change on an enrichment configuration.

A free-form update, matching the app: whatever keys are sent are written. updated_by is set from the calling key and cannot be supplied.

object
is_active
Any of:
boolean
name
Any of:
string
key
additional properties
any

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