Skip to content

Start Enrichment

POST
/enrichment/enrich

Start an async waterfall enrichment job. Returns a job_id to poll for results.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Request to start an async waterfall enrichment job.

object
contact_ids
required

Contact IDs to enrich

Array<integer>
fields_config
Any of:
object
key
additional properties
Array<string>
list_id
required

List ID the contacts belong to

integer

Responses

202

Successful Response

object
data
required
object
completed
Any of:
integer
failed_enrichments
Any of:
integer
job_id
required
string
provider_errors
Any of:
Array<object>
object
key
additional properties
any
results
Any of:
Array<object>
object
key
additional properties
any
status
required
string
successful_enrichments
Any of:
integer
total
Any of:
integer
total_credits_used
Any of:
integer
warnings
Any of:
Array<string>
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