Users: InviteClassicManager

Invites a new user to join a company account on Rooms Version 5 as a Manager.

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.

Request

HTTP request

POST /v2/accounts/{accountId}/users/invite_classic_manager

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Request Body

invitee

Responses

CodeDescriptionReference
201

User successfully invited.

User
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Users::InviteClassicManager

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.

ClassicManagerPermissions

This object contains details about user permissions. These permissions are associated only with Rooms v5.

isVisibleInTransactionRoomsboolean

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.

canDeleteCompanyRoomsboolean

When set to true, the user can delete company rooms.

canDeleteCompanyDocumentsboolean

When set to true, the user can delete company documents.

canManageCompanyRoomsboolean

When set to true, the user can manage company rooms.

canManageCompanyAccountboolean

When set to true, the user can manage the company's account.

canManageCompanySharedLibraryboolean

When set to true, the user can manage the company's shared library.

canManageCompanyMembersboolean

When set to true, the user can manage other users on the company's account.

canCloseCompanyRoomsboolean

When set to true, the user can close company rooms.

canApproveCompanyChecklistsboolean

When set to true, the user can approve company checklists.

isCompanySystemAdminboolean

When set to true, the user is a system administrator for the company.

isRegionManagerboolean

When set to true, the user is a region manager.

isOfficeManagerboolean

When set to true, the user is an office manager.

autoAccessToCompanyRoomsboolean

When set to true, the user is automatically added to new company rooms and is visible in those rooms.

ClassicManagerToInvite

This request object contains details about the person who you want to invite.

firstNamestring

(Required) The user's first name.

lastNamestring

(Required) The user's last name.

emailstring

(Required) The user's email address.

defaultOfficeIdinteger

(Required) The id of the user's default office.

titleIdinteger

(Required) In Rooms v5, 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 v6, use the Users::InviteUser method with the roleId property instead.

accessLevelstring

(Required) 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 accessLevel set to Company can see all of the rooms associated with their company. However, if they do not have the canDeleteCompanyRooms permission set to true, they can't delete those rooms.

Valid values for a Manager are:

  • Company: The user has access to rooms, and if they have permission to manage users, they have access to users across the entire company. What they can do in the rooms and with users is controlled by their permissions. This is the default for the Users::InviteClassicAdmin method.
  • Region: The user has access to rooms and, if they have permission to manage users, they have access to users across their regions.
  • Office: The user has access to rooms, and if they have permission to manage users, they have access to users across their offices.

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.

permissionsClassicManagerPermissions

(Required) An object that contains details about the user's permissions.

Note: These permissions only apply to Rooms v5.

offices[array]

An array of office ids for the offices to which the user belongs.

Note: You only specify the offices property when the user's accessLevel is office.

regions[array]

An array of region ids for the regions to which the user belongs.

Note: You only specify the regions property when the user's accessLevel is region.

eSignPermissionProfileIdstring

(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 eSignPermissionProfileId is the id of the eSignature permission set to assign to the member.

User

Contains details about a user.

userIdinteger

The id of the user.

emailstring

The user's email address.

firstNamestring

The user's first name.

lastNamestring

The user's last name.

isLockedOutboolean

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.

statusstring

The user's status. Read only. Possible values are:

  • Active: The user is active.
  • Pending: The user has been invited but has not yet accepted the invitation.

accessLevelstring

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 accessLevel set to Company can see all of the rooms associated with their company. However, if they do not have a role for which the Add documents to room permission is set to true, they can't add documents to those rooms.

Valid values are:

  • Company: The user has access to rooms, and if they have permission to manage users, they have access to users across the entire company. What they can do in the rooms and with users is controlled by their permissions. This is the default for the Users::InviteClassicAdmin method.
  • Region: The user has access to rooms and, if they have permission to manage users, they have access to users across their regions.
  • Office: The user has access to rooms and, if they have permission to manage users, they have access to users across their offices.
  • Contributor: The user has access only to their own rooms and those to which they are invited. They cannot perform any user management actions because they do not oversee other users. For example, agents typically have the Contributor access level.

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.

defaultOfficeIdinteger

The id of the user's default office.

titleIdinteger

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 titleId when using the Users::InviteClassicManager method. (The titleId property is empty for Agent users on Rooms Version 5.) If you are using Rooms Version 6, use the Users::InviteUser method with the roleId property instead.

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.

profileImageUrlstring

The URL for the user's profile image.

offices[array]

An array of office ids for the offices in which a user with an Office or Contributor accessLevel has been granted the ability to participate.

regions[array]

An array of region ids for the regions in which a user with the Region accessLevel has been granted the ability to participate.

permissionsClassicManagerPermissions

An object that contains details about a manager user's permissions.

Note: These permissions only apply to Rooms v5.

}} />