Rooms: InviteUser

This method invites an existing or new member to a specific room.

You can invite anyone to join a room by specifying their email address.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

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

Request Body

roomInviteRequest

Responses

CodeDescriptionReference
201

The user was successfully invited to the room.

RoomInviteResponse
400

The user could not be invited to the room.

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::InviteUser

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.

RoomInvite

The information to use for the invitation.

emailstring

The user's email address.

firstNamestring

The user's first name.

lastNamestring

The user's last name.

roleIdinteger

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

You can assign external roles to users who are not part of your organization.

Note: If you are using Rooms Version 6, you must enter a roleId in requests. If you are using Rooms Version 5, you must use one of the Users::InviteClassic methods with the titleId property instead.

transactionSideIdstring

The id of the transaction side. Valid values are:

  • buy
  • sell
  • listbuy
  • refi

RoomInviteResponse

Information about the sent invitation.

userIdinteger

The id of the user.

roomIdinteger

The id of the room.

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

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.

}} />