Delete Room

Prev Next
Post
/api/v1/rooms.delete

Delete a room from the workspace. The following permissions are required:

  • delete-c: To delete a public room.
  • delete-d: To delete direct messages.
  • delete-p: To delete private rooms.
  • delete-team: To delete a team.
  • delete-team-channel: To delete a channel within a team, also requires the delete-c permission.
  • delete-team-group: To delete a private channel within a team, also requires the delete-p permission.

Changelog

Version Description
5.4.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
object
roomId
string Required

The room ID that you want to delete.

ExampleByehQjC44FwMeiLbX
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1: Missing roomId
{
  "success": false,
  "error": "The 'roomId' param is required"
}
Example 2: Missing Permission
{
  "success": true,
  "error": "string"
}
Example 3: Cannot Delete Team Channel
{
  "success": false,
  "error": "Cannot delete a team channel [error-cannot-delete-team-channel]",
  "errorType": "error-cannot-delete-team-channel",
  "details": {
    "method": "eraseRoom"
  }
}
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