Update Agents of Department
- Print
- DarkLight
- PDF
Update Agents of Department
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/livechat/department/{_id}/agents
Update the agents of a specific department. At least one of the following permissions is required:
add-livechat-department-agentsmanage-livechat-departments
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired
The department ID.
Body parameters
Example 1
{
"upsert": [
{
"agentId": "6529401b024dde05d3f1cd85",
"username": "kim"
}
],
"remove": []
}object
upsert
Array of object Required
The object that contains the agent details.
object
agentId
string Required
The agent ID.
username
string Required
The user name of the agent.
remove
Array of object Required
The object containing the details of the agent that you want to remove.
object
Responses
200
OK
Example 1
{
"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
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?