Update Agent Info

Prev Next
Post
/api/v1/livechat/agents.saveInfo

Update an Omnichannel agent's information. Permission required: manage-livechat-agents.

Changelog

Version Description
7.11.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
  "agentId": "4zqiF9BSWmBTe6yvt",
  "agentData": {},
  "agentDepartments": [
    ""
  ]
}
Expand All
object
agentId
string Required

Enter the agent's ID.

agentData
object Required

Enter the agent data that you want to update.

agentDepartments
Array of string Required

Enter the agent's departments. You can leave it as an empty string if you don't want to add any departments.

string
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string