Post
/api/v1/livechat/inquiries.returnAsInquiry
This endpoint is used to move an open chat to the queue. Permission required: view-l-room
Changelog
| Version | Description |
|---|---|
| 7.12.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
{
"roomId": "iFzJuwGtkg4KB4keW",
"departmentId": "66fa9ec66ea9eba859b650b3"
}object
roomId
string Required
Enter the room ID that you want to return to the queue.
departmentId
string
Enter the department ID that the chat is part of.
Responses
200
OK
Example 1
{
"result": true,
"success": true
}Inquiry already exists
{
"result": false,
"success": true
}object
result
boolean
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "room-closed"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string