Post
/api/v1/livechat/rooms.delete
Use this endpoint to delete a specific closed Omnichannel room from the workspace. Permission required: remove-closed-livechat-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": "nXHYnNu38qKRRtZDi"
}object
roomId
string Required
Enter the ID of the closed livechat room that you want to delete.
ExamplenXHYnNu38qKRRtZDi
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"errorType": "invalid-params",
"error": "must have required property 'roomId'"
}object
success
boolean
errorType
string
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string