contacts

Enrich Contact

Changed on

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

The person described in the body is saved as a contact in your workspace: an existing contact is found by LinkedIn URL, then email, then name and company domain, and is never overwritten. Its missing email is then asked from Topo's lead database and an enrichment provider, which spends enrichment credits, and saved on the contact. Use POST /v1/contacts/get-and-enrich to start from a contact you already store.

A lookup that is still running after about 20 seconds returns completed: false with an enrichment_id: collect the answer with GET /v1/contacts/enrichments/{enrichment_id} rather than enriching again.

Requires the contacts:write scope on the API key.

post/v1/contacts/enrich

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contacts/enrich
  • Auth: HTTP bearer

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 while the lookup is still running: collect the answer with enrichment_id.

enrichment_idstring uuid nullable

Set when completed is false: pass it to GET /v1/contacts/enrichments/{enrichment_id} to collect the answer instead of enriching again.

contact_idstring uuid nullable

The workspace contact the answer was saved on.

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.

Changes

  • ac7ed6acc0d1Revision changes
    • info

      added the optional property to the response with the status

  • 16f692efb3dbRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status