{"api":"esign_rest","category":"reference"}

Users Resource

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 active.

Inviting a user to a room

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.

Adding a user to a company Rooms account

This section describes how to add users in each version of the Rooms product, as well as the permissions required to perform this action.

Rooms Version 5

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 true.

In Rooms Version 5, you use the inviteClassicAdmin, inviteClassicAgent, and inviteClassicManager methods.

Rooms Version 6

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.

Using the API to invite a user

The Rooms API method that you use to invite a user depends on the version of Rooms that you are using.

Rooms Version 5

Rooms Version 5 offers the following API methods, which enable you to invite users by predefined role:

Rooms Version 6

If you are using Rooms Version 6, you can use a single API method to invite users and assign them to custom roles:

InviteUser

MethodDescription
GetUsers
GET /restapi/v2/accounts/{accountId}/users

Gets a list of users.

GetUser
GET /restapi/v2/accounts/{accountId}/users/{userId}

Gets a user.

UpdateUser
PUT /restapi/v2/accounts/{accountId}/users/{userId}

Updates a user's default office.

RemoveUser
DELETE /restapi/v2/accounts/{accountId}/users/{userId}

Removes a user from a company account.

AddUserToOffice
POST /restapi/v2/accounts/{accountId}/users/{userId}/add_to_office

Adds a user to an office.

AddUserToRegion
POST /restapi/v2/accounts/{accountId}/users/{userId}/add_to_region

Adds a user to a region.

LockUser
POST /restapi/v2/accounts/{accountId}/users/{userId}/lock

Locks a user's account.

ReinviteUser
POST /restapi/v2/accounts/{accountId}/users/{userId}/reinvite

Reinvites a user to join a company account.

RemoveUserFromOffice
POST /restapi/v2/accounts/{accountId}/users/{userId}/remove_from_office

Removes a user from an office.

RemoveUserFromRegion
POST /restapi/v2/accounts/{accountId}/users/{userId}/remove_from_region

Removes a user from a region.

UnlockUser
POST /restapi/v2/accounts/{accountId}/users/{userId}/unlock

Unlocks a user's account.

InviteClassicAdmin
POST /restapi/v2/accounts/{accountId}/users/invite_classic_admin

Invites a user to a v5 company account as an Admin.

InviteClassicAgent
POST /restapi/v2/accounts/{accountId}/users/invite_classic_agent

Invites a user to a v5 company account as an Agent.

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

Invites a user to a v5 company account as a Manager.

InviteUser
POST /restapi/v2/accounts/{accountId}/users/invite_user

Invites a user to a v6 company account.

}} />