Rooms: DeleteRoom

This method deletes a room.

Note: To use this method, you must have permissions to delete rooms.

In Rooms v5, you must be one of the following:

  • An Admin
  • A Manager with the individual-level canDeleteCompanyRooms permission set to true
  • An Agent with the role-level Agents can delete Rooms permission set to true

In Rooms v6, you must be assigned a role that has the Delete Owned Rooms permission set to true in the console. If you manage other members, this permission also enables you to delete rooms that are owned by the users that you manage.

Request

HTTP request

DELETE /restapi/v2/accounts/{accountId}/rooms/{roomId}

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
204

Room successfully deleted.

400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::DeleteRoom

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />