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

Users Category

A user is a person who is either added to a room (as a participant), or who is a member of a company. This section shows you how to manage users, including how to update and delete National Association of REALTORSĀ® member numbers.

Users

The Users resource provides methods that enable you to add, update, delete, and manage users. A user is a person who is either added to a room (as a participant), or who is a member of a company.

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.

}} />