A new user is created when an account administrator or another authorized user sends an invitation to an email address. After the invitation is sent, the user's status is
pending. When the recipient accepts the invitation, their user status switches to
To invite a user to a room, use the Rooms_InviteUser method. You can invite anyone to join a room by specifying their email address.
Note: In Rooms Version 6, you must have the
canAddUsersToRooms permission set to true to invite a user to a room.
This section describes how to add users in each version of the Rooms product, as well as the permissions required to perform this action.
To invite users to a company in Rooms Version 5, you must either be an Admin or have a Manager role for which the
canManageCompanyMembers permission is set to
In Rooms Version 5, you use the
To invite users to a company in Rooms Version 6, you must be either an account administrator (In Rooms Version 6, this is the Default Admin) or another authorized user who is assigned a company role that has one of the following
userPermissions set to true:
canAddMemberAndSetRoleLowerAccessLevel: Users can add other users who have a lower access level than their own and set those users' roles (in offices or regions that they oversee).
canAddMemberAndSetRoleSameAccessLevel: Users can add other users who have the same access level as their own and set those users' roles (in offices or regions that they oversee or belong to).
In Rooms Version 6, you use the Users_inviteUser method.
Note: Before you invite users in the Rooms Version 6, we strongly recommend that you set up custom roles for your company. For more information, see Roles.
The Rooms API method that you use to invite a user depends on the version of Rooms that you are using.
Rooms Version 5 offers the following API methods, which enable you to invite users by predefined role:
If you are using Rooms Version 6, you can use a single API method to invite users and assign them to custom roles:
Gets a list of users.
Gets a user.
Updates a user's default office.
Removes a user from a company account.
Adds a user to an office.
Adds a user to a region.
Locks a user's account.
Reinvites a user to join a company account.
Removes a user from an office.
Removes a user from a region.
Unlocks a user's account.
Invites a user to a v5 company account as an Admin.
Invites a user to a v5 company account as an Agent.
Invites a user to a v5 company account as a Manager.
Invites a user to a v6 company account.