Skip to main content
GET
Query Sales Agent settings

Headers

Authorization
string
required

Bearer [access_token]

Response

Settings retrieved successfully.

Sales agent setting response

id
integer<int64>

AI Assistant ID

Example:

12345

assistantName
string

Assistant name

Example:

"Anna"

headUrl
string

Assistant avatar URL

Example:

"https://example.com/avatar.jpg"

virtualNumber
string

Virtual phone number

Example:

"+1234567890"

virtualNumberCountry
string

Virtual number country

Example:

"US"

callTransferType
string

Call transfer type: Disabled, ToAssignedAgent

Example:

"Disabled"

fixedNumber
string

Fixed phone number

Example:

"+1234567890"

agentExperience
string

Agent experience description

Example:

"10 years in real estate"

rentalBusiness
boolean

Whether agent handles rental business

Example:

false

websiteChannel
boolean

Whether website channel is enabled

Example:

true

textChannel
boolean

Whether text channel is enabled

Example:

true

emailChannel
boolean

Whether email channel is enabled

Example:

true

startActiveHour
integer<int32>

Active start hour (0-23)

Example:

8

endActiveHour
integer<int32>

Active end hour (0-23)

Example:

20

activeDays
integer<int32>[]

Active days of week (0=Sun, 6=Sat)

Example:
leadTypes
integer<int32>[]

Lead types filter

Example:
leadSources
integer<int64>[]

Lead source IDs filter

Example:
leadPipelines
integer<int64>[]

Lead pipeline IDs filter

Example:
agentIds
integer<int64>[]

Agent IDs with access

Example:
officeIds
integer<int64>[]

Office IDs with access

Example:
leadPondIds
integer<int64>[]

Lead pond IDs with access

Example:
newLeadEnable
boolean

Whether new lead follow-up is enabled

Example:

true

visitorsEnable
boolean

Whether visitor follow-up is enabled

Example:

true

followUpRole
string

Follow up role: AI or Agent

Example:

"AI"

hostedStatus
string

Hosted status

Example:

"ACTIVE"