Skip to main content
POST
Refine a lead search conversationally

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The builder's current state plus the user's next request.

message
string
required
Required string length: 1 - 4000
record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
companies
CompanyQuerySchema · object | null

Filters for a company search.

history
LeadAssistantMessageSchema · object[]
Maximum array length: 40
locale
string
default:""
Maximum string length: 35
people
PeopleQuerySchema · object | null

Filters for a people search.

timezone
string
default:""
Maximum string length: 64

Response

Successful Response

The assistant's answer: new filter state plus its explanation.

explanation
string
required
query
Query · object
required
record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
alternative
LeadAssistantAlternativeSchema · object | null

The reading not chosen for an ambiguous ask, applied with one tap.

question
string | null
question_options
string[]