Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Provide your API key in the x-api-key header.

Body

application/json
enrichment_type
enum<string>[]
required

Types of enrichment to perform.

Minimum array length: 1
Available options:
email,
phone,
profile
contacts
object[]
required

Contacts to enrich.

Minimum array length: 1
webhook_url
string<uri>
required

Webhook endpoint to receive enrichment results.

custom
object
detect_job_change
boolean

When true, the webhook response will include a jobChangeDetected field indicating whether the contact has changed company since the input data was provided.

Only effective when enrichment_type includes "profile" and webhook_url is provided.

force_refresh
boolean

Opt out of the 24h enrichment cache for this call. When a contact was already enriched for your account within the last 24 hours, the cached result is returned and no credits are consumed; pass true to force a fresh enrichment instead (credits are consumed and the cache entry is refreshed).

Response

Enrichment successfully created