contacts

Enrich Contact

Find a contact's missing details from what you already know about them.

This does not read or write your workspace: it asks an enrichment provider about the person described in the body and returns what came back, so it spends enrichment credits. Use POST /v1/contacts/get-and-enrich to start from a contact you already store, and POST /v1/contacts to persist the result.

A provider that answers asynchronously returns completed: false with the provider still working in pending_provider; retry to pick the answer up.

Requires the contacts:write scope on the API key.

post/v1/contacts/enrich

Request body

emailstring nullable

Email, if known.

linkedin_urlstring nullable

LinkedIn profile URL, if known.

first_namestring nullable

First name, if known.

last_namestring nullable

Last name, if known.

company_namestring nullable

Employer name, if known.

company_domainstring nullable

Employer's primary domain, if known.

Response

Successful Response

completedboolean required

Whether enrichment finished. false when a provider answers later.

pending_providerstring nullable

Provider still working on the missing fields.

emailstring nullable

Email.

first_namestring nullable

First name.

last_namestring nullable

Last name.

job_titlestring nullable

Job title.

linkedin_urlstring nullable

LinkedIn profile URL.

phone_numberstring nullable

Phone number.

company_namestring nullable

Employer name.

company_domainstring nullable

Employer's primary domain.