Skip to main content
POST
Qualify Person Agent

Authorizations

api_key
string
header
required

Body

application/json

Qualify input

agentOId
string
required

AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.

Example:

"agent_123"

email
string | null

Email of the person to qualify

Example:

"john.doe@example.com"

firstName
string | null

First name of the person to qualify

lastName
string | null
jobTitle
string | null

Job title of the person to qualify

companyDomain
string | null

Company domain of the person to qualify

Example:

"example.com"

companyName
string | null

Company name of the person to qualify

linkedInProfile
string | null

LinkedIn profile of the person to qualify

crmContactId
string | null
crmLeadId
string | null
crmAccountId
string | null
runtimeContext
any | null

Runtime context for qualification

includeFullAnnotation
boolean

If true, returns full annotation data including metadata. If false or omitted (default), returns minimal annotations to reduce response size.

Response

Qualification successful

_metadata
object
required
found
boolean
required

Whether the operation was successful

Example:

true

message
string | null

Message

Example:

"Additional information"

data
object | null