Invites a new user to join a company account on Rooms Version 5 as an Agent.
To invite users to a company in Rooms Version 5, you must either be an Admin or a Manager for whom the
canManageCompanyMembers permission is set to true.
Note: If you are using Rooms Version 6, use the Users_InviteUser method instead.
(Required) The globally-unique identifier (GUID) for the account.
User successfully invited.
Bad request. See ErrorCode and Message for details
Not authorized to make this request.
This object describes errors that occur. It is valid only for responses and ignored in requests.
The code associated with the error condition.
A brief message describing the error condition.
This request object contains details about the person who you want to invite.
(Required) The user's first name.
(Required) The user's last name.
(Required) The user's email address.
(Required) The id of the office. This is the id that the system generated when you created the office.
(Required) When an administrator or authorized member invites a new user to become an account member, the system also creates an eSignature account for the invitee at the same time. The
This object contains details about user permissions. These permissions are associated only with Rooms v5.
When set to true, the user is visible in company rooms.
Note: Inherited managers are automatically added to rooms and are visible in those rooms unless this setting is set to false. Inherited managers are users who oversee others and have the auto-access to rooms of members the user manages permission enabled.
When set to true, the user can delete company rooms.
When set to true, the user can delete company documents.
When set to true, the user can manage company rooms.
When set to true, the user can manage the company's account.
When set to true, the user can manage the company's shared library.
When set to true, the user can manage other users on the company's account.
When set to true, the user can close company rooms.
When set to true, the user can approve company checklists.
When set to true, the user is a system administrator for the company.
When set to true, the user is a region manager.
When set to true, the user is an office manager.
When set to true, the user is automatically added to new company rooms and is visible in those rooms.
Contains details about a user.
The id of the user.
The user's email address.
The user's first name.
The user's last name.
When set to true, an administrator has locked the user's account. For example, an administrator might want to lock an agent's account after they leave the brokerage until they determine how to transfer the agent's rooms and data to another active user.
The user's status. Read only. Possible values are:
The user's level of access to the account. This property determines what the user can see in the system.
In contrast, a user's permissions determine the actions that they can take in a room. For example, a user who has
Valid values are:
Note: In requests, the values that you may use for this property depend on your permissions and whether you can add users at your access level or lower.
The id of the user's default office.
In Rooms Version 5, this is the id of the custom job title for a Manager role within your company. For example, your company might have the custom job titles "Transaction Coordinator" and "Office Manager".
Note: If you are using Rooms Version 5, you must enter a
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
The URL for the user's profile image.
An array of office ids for the offices in which a user with an
An array of region ids for the regions in which a user with the
An object that contains details about a manager user's permissions.
Note: These permissions only apply to Rooms v5.