Remove Closed Omnichannel Rooms

Prev Next
Post
/api/v1/livechat/rooms.removeAllClosedRooms

Use this endpoint to remove closed Omnichannel rooms.

Permission required: remove-closed-livechat-rooms. (On the workspace UI, go to Administration > Workspace > Permissions. Search for the Remove All Closed Omnichannel Rooms permission. By default, livechat managers and monitors have this permission.)

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
Responses
200

OK

Example 1
{
  "removedRooms": 19,
  "success": true
}
object
removedRooms
integer
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]"
}
object
success
boolean
error
string