{"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 /v2/accounts/{accountId}/rooms

Gets rooms.

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

Creates a room.

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

Gets a room.

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

Deletes a room.

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

Gets assignable room-level roles in v6.

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

Gets a list of documents in a room.

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

Adds a document to a room.

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

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

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

Gets room members.

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

Invites a user to a room.

}} />