Rooms: RevokeRoomUserAccess

Revokes the specified user's access to the room. If successful, the HTTP result is 204 (No content), and the response is empty.

To revoke access immediately, leave the request body empty.

To revoke access on a specific date, use the request body to specify a date.

Note If a user doesn't have access to a room, and you revoke their access at a future date, the user will be granted access until the revocation date.

Request

HTTP request

POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

The id of the room.

userIdinteger

The id of the user.

accountIdstring

The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
204

The room user's access was successfully revoked.

400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::RevokeRoomUserAccess

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.

RoomUserRemovalDetail

Details for removal.

revocationDatestring

The date on which the users room access should be revoked in ISO 8601 fomat: 1973-12-31T07:54Z.

}} />