Qualify Contact
Check whether a contact matches your ideal customer profile.
POST
/
v1
/
contacts
/
qualify
Qualify Contact
curl --request POST \
--url https://api.topo.io/v1/contacts/qualify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_name": "<string>",
"company_domain": "<string>",
"icp_context": "<string>",
"criteria": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
first_name: '<string>',
last_name: '<string>',
job_title: '<string>',
company_name: '<string>',
company_domain: '<string>',
icp_context: '<string>',
criteria: '<string>'
})
};
fetch('https://api.topo.io/v1/contacts/qualify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/contacts/qualify"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_name": "<string>",
"company_domain": "<string>",
"icp_context": "<string>",
"criteria": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"verdict": true,
"score": 123,
"reasons": [
"<string>"
]
}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.Authorizations
Bearer API key issued from Settings → Developers.
Body
application/json
Qualify Contact payload
Contact to qualify. Its stored details fill in the fields below.
First name.
Last name.
Job title.
Employer name.
Employer's primary domain.
Description of your ideal customer profile to check the contact against.
Extra qualification criteria the contact must meet.
Was this page helpful?
⌘I
Qualify Contact
curl --request POST \
--url https://api.topo.io/v1/contacts/qualify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_name": "<string>",
"company_domain": "<string>",
"icp_context": "<string>",
"criteria": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
first_name: '<string>',
last_name: '<string>',
job_title: '<string>',
company_name: '<string>',
company_domain: '<string>',
icp_context: '<string>',
criteria: '<string>'
})
};
fetch('https://api.topo.io/v1/contacts/qualify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/contacts/qualify"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_name": "<string>",
"company_domain": "<string>",
"icp_context": "<string>",
"criteria": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"verdict": true,
"score": 123,
"reasons": [
"<string>"
]
}