Rooms: PutRoomUser

You can use this method to update the following information for a room user:

  • roleId
  • transactionSideId

In the console, this is the Side and role information that appears in the room's People tab. You specify the information that you want to update in the roomUserForUpdate request body.

Permissions

Rooms Version 6: Only the person who invited the room user to the room can update the room user.

Rooms Version 5: The following permissions apply in Rooms Version 5:

  • The person who invited the room user to the room can update the room user.
  • Any room owner can update any room user.
  • A Manager who has the CanManageCompanyRooms permission and who manages the person who invited the room user can update the room user.

Request

HTTP request

PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

userIdinteger

(Required) The id of the user to update.

accountIdstring

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

Request Body

roomUserForUpdate

Responses

CodeDescriptionReference
200

The room user was successfully updated.

RoomUser
400

The room user could not be updated.

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::PutRoomUser

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.

RoomUser

This object contains details about a specific room member.

userIdinteger

The id of the user.

emailstring

The user's email address.

firstNamestring

The user's first name.

lastNamestring

The user's last name.

transactionSideIdstring

The id of the transaction side. Valid values are:

  • buy
  • sell
  • listbuy
  • refi

roleIdinteger

The id of the user's role.

isRevokedboolean

When set to true, indicates that the user's access to the room has been revoked.

invitedByUserIdinteger

The userId of the person who invited the room user to the room.

RoomUserForUpdate

This request object contains the information that you want to update for the room user.

roleIdinteger

In Rooms v6, this is the id of the company role assigned to the user.

You can assign external roles to users who aren't a part of your organization.

Note: If you are using Rooms v6, you must enter a roleId in requests. If you are using Rooms v5, you must enter a value for the titleId property instead.

transactionSideIdstring

The id of the transaction side. Valid values are:

  • buy
  • sell
  • listbuy
  • refi

}} />