contacts

Qualify Contact

Changed on

Check whether a contact matches your ideal customer profile.

Pass a contact_id to qualify a stored contact, or describe the person inline to qualify one you have not imported yet. The workspace's own ICP is used unless icp_context overrides it.

Requires the contacts:read scope on the API key.

post/v1/contacts/qualify

Request

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

Request body

contact_idstring uuid nullable

Contact to qualify. Its stored details fill in the fields below.

first_namestring nullable

First name.

last_namestring nullable

Last name.

job_titlestring nullable

Job title.

company_namestring nullable

Employer name.

company_domainstring nullable

Employer's primary domain.

company_industrystring nullable

Employer's industry.

company_employee_countinteger nullable

Employer's employee count.

company_countrystring nullable

Employer's country.

icp_contextstring nullable

Description of your ideal customer profile to check the contact against.

criteriastring nullable

Extra qualification criteria the contact must meet.

Response

Successful Response

verdictboolean required

Whether the contact matches the profile and criteria.

scoreinteger required

Qualification score out of 100.

reasonsstring[] required

Why the verdict was reached, one reason per entry.

Changes

  • 62914910b2a8Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • ad6ac1d13526Revision changes
    • info

      endpoint added