Skip to main content
POST
Qualify Company 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"

companyDomain
string | null

Company domain to qualify

Example:

"example.com"

companyName
string | null

Company name to qualify

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