Skip to content

Delete Find People Config

DELETE
/enrichment/find-people/{config_id}

Remove a people-search configuration. Free.

hard_delete DEFAULTS TO TRUE here, unlike every other delete on this surface, which defaults to false. That asymmetry is the app’s and is documented rather than quietly normalised - changing it would make this endpoint behave differently through the API than through the browser.

Authorizations

Parameters

Path Parameters

config_id
required

Configuration id (UUID).

string

Configuration id (UUID).

Query Parameters

hard_delete

TRUE BY DEFAULT, matching the app: the configuration is removed permanently rather than deactivated. Pass false to keep it. Contacts already imported are unaffected either way.

boolean
default: true

TRUE BY DEFAULT, matching the app: the configuration is removed permanently rather than deactivated. Pass false to keep it. Contacts already imported are unaffected either way.

Header Parameters

X-Target-Org-Id
Any of:
string

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