v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Sales Agents V2

Update Sales Agent settings

Update the Sales Agent settings for the current user. Sales Agent creation must be completed in CRM. This API only supports updating existing settings.

put/v2.0/sales-agent/settings

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

idinteger

Sales Agent ID (required, must be greater than 0)

assistantNamestring

Assistant name

virtualNumberstring

Virtual phone number

virtualNumberCountrystring

Virtual number country

callTransferTypestring

Call transfer type: Disabled, ToAssignedAgent

fixedNumberstring

Fixed phone number

agentExperiencestring

Agent experience description

rentalBusinessboolean

Whether agent handles rental business

websiteChannelboolean

Whether website channel is enabled

textChannelboolean

Whether text channel is enabled

emailChannelboolean

Whether email channel is enabled

startActiveHourinteger

Active start hour (0-23)

endActiveHourinteger

Active end hour (0-23)

activeDaysinteger[]

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

leadTypesinteger[]

Lead types filter, empty means all

leadSourcesinteger[]

Lead source IDs filter, empty means all

leadPipelinesinteger[]

Lead pipeline IDs filter, empty means all

agentIdsinteger[]

Agent IDs with access, contains -1 means all

officeIdsinteger[]

Office IDs with access, contains -1 means all

leadPondIdsinteger[]

Lead pond IDs with access, contains -1 means all

newLeadEnableboolean

Whether new lead follow-up is enabled

visitorsEnableboolean

Whether visitor follow-up is enabled

followUpRolestring

Follow up role: AI or Agent

Example request

{
  "id": 12345,
  "assistantName": "Anna",
  "virtualNumber": "+1234567890",
  "virtualNumberCountry": "US",
  "callTransferType": "Disabled",
  "fixedNumber": "+1234567890",
  "agentExperience": "10 years in real estate",
  "websiteChannel": true,
  "textChannel": true,
  "emailChannel": true,
  "startActiveHour": 8,
  "endActiveHour": 20,
  "activeDays": [
    1,
    2,
    3,
    4,
    5
  ],
  "leadTypes": [
    1,
    2
  ],
  "leadSources": [
    1001,
    1002
  ],
  "leadPipelines": [
    2001,
    2002
  ],
  "agentIds": [
    101,
    102
  ],
  "officeIds": [
    201,
    202
  ],
  "leadPondIds": [
    301,
    302
  ],
  "newLeadEnable": true,
  "visitorsEnable": true,
  "followUpRole": "AI"
}

Response

Settings updated successfully.

messagestring

Result message

Example response

{
  "message": "Operation successful"
}