Post
/api/v1/livechat/agent.status
Update the agent's livechat status. If the agent is available, using this endpoint will set the status as unavailable, and vice versa. Permission required: view-l-room.
If you want to update the status of another agent, you need the manage-livechat-agents permission. If you have configured business hours, the agent status cannot be updated outside of business hours.
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": "J6Q87AnWP5aNc9xhx"
}object
agentId
string
Enter this parameter if you want to update the livechat status of another agent. If this parameter is not provided, the agent that is calling the endpoint will be updated.
ExampleJ6Q87AnWP5aNc9xhx
Responses
200
OK
Example 1
{
"status": "not-available",
"success": true
}object
status
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string