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

Rooms Category

A room can hold documents, envelopes, a list of tasks comprising a workflow, and other related information. You can invite others to this space and assign them permissions on a per-room basis. The documentation in this section shows you how to perform these and other tasks.

Rooms

The Rooms resource provides methods that enable you to create and manage rooms. In Rooms for Real Estate, a room is a collaborative digital space corresponding to a specific property. In Rooms for Mortgages, a room corresponds to a specific loan.

MethodDescription
GetRooms
GET /restapi/v2/accounts/{accountId}/rooms

Returns a list of rooms.

CreateRoom
POST /restapi/v2/accounts/{accountId}/rooms

Creates a room.

GetRoom
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}

Gets a room.

DeleteRoom
DELETE /restapi/v2/accounts/{accountId}/rooms/{roomId}

Deletes a room.

GetAssignableRoles
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles

Gets assignable room-level roles in v6.

GetDocuments
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents

Gets a list of documents in a room.

AddDocumentToRoom
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents

Adds a document to a room.

AddDocumentToRoomViaFileUpload
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents/contents

Uploads the contents of a file as a document to a room.

GetRoomFieldData
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data

Gets a room's field data.

UpdateRoomFieldData
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data

Updates a room's field data.

GetRoomFieldSet
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_set

Gets the field set for a room.

AddFormToRoom
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/forms

Adds a form to a room.

UpdatePicture
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/picture

Updates the picture for a room.

GetRoomUsers
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/users

Gets a room's users.

InviteUser
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users

Invites a user to a room.

PutRoomUser
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}

Updates a room user.

RestoreRoomUserAccess
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/restore_access

Restores the specified user's access to the room.

RevokeRoomUserAccess
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access

Revokes the specified user's access to the room.

RoomFolders

MethodDescription
GetRoomFolders
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/room_folders

Gets a list of room folders accessible to the current user.

}} />