{ "swagger": "2.0", "info": { "title": "DocuSign Rooms API - v2", "description": "An API for an integrator to access the features of DocuSign Rooms", "termsOfService": "https://www.docusign.com/company/terms-and-conditions/web", "contact": { "name": "DocuSign Developer Center", "url": "https://developers.docusign.com", "email": "devcenter@docusign.com" }, "version": "v2" }, "host": "demo.rooms.docusign.com", "basePath": "/restapi", "schemes": [ "https" ], "license": { "name": "Terms and Conditions", "url": "https://www.docusign.com/company/terms-and-conditions/web" }, "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "paths": { "/v2/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "summary": "Gets account information.", "description": "Returns details about a company account.", "operationId": "Accounts_GetAccountInformation", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Account information successfully retrieved", "schema": { "$ref": "#/definitions/AccountSummary" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetAccountInformation", "x-ds-method": "GetAccountInformation", "x-ds-service": "Accounts", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/documents/{documentId}": { "get": { "tags": [ "Documents" ], "summary": "Gets information about or the contents of a document.", "description": "Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\n\nTo find the `documentId` of the document that you want to retrieve, use the Rooms: GetDocuments method.", "operationId": "Documents_GetDocument", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "documentId", "description": "The ID of the document.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeContents", "description": "When **true,** includes the contents of the document in the `base64Contents` property of the response. The default value is **false.**", "type": "boolean", "default": false }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Document successfully retrieved.", "schema": { "$ref": "#/definitions/Document" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetDocument", "x-ds-method": "GetDocument", "x-ds-service": "Documents", "x-ds-in-sdk": true }, "delete": { "tags": [ "Documents" ], "summary": "Deletes a specified document.", "description": "Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms: GetDocuments method.\n\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.", "operationId": "Documents_DeleteDocument", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "documentId", "description": "The ID of the document.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Document has been successfully deleted." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteDocument", "x-ds-method": "DeleteDocument", "x-ds-service": "Documents", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/documents/{documentId}/users": { "post": { "tags": [ "Documents" ], "summary": "Grants a user access to a document.", "description": "Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.", "operationId": "Documents_CreateDocumentUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "documentId", "description": "The ID of the document.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DocumentUserForCreate" } } ], "responses": { "201": { "description": "User successfully granted access to document.", "schema": { "$ref": "#/definitions/DocumentUser" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateDocumentUser", "x-ds-method": "CreateDocumentUser", "x-ds-service": "Documents", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/esign_permission_profiles": { "get": { "tags": [ "ESignPermissionProfiles" ], "summary": "Gets eSignature Permission Profiles.", "description": "When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.", "operationId": "ESignPermissionProfiles_GetESignPermissionProfiles", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Permission profiles successfully retrieved.", "schema": { "$ref": "#/definitions/ESignPermissionProfileList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetESignPermissionProfiles", "x-ds-method": "GetESignPermissionProfiles", "x-ds-service": "ESignPermissionProfiles", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/external_form_fill_sessions": { "post": { "tags": [ "ExternalFormFillSessions" ], "summary": "Creates an external form fill session.", "description": "Returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body.", "operationId": "ExternalFormFillSessions_CreateExternalFormFillSession", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/ExternalFormFillSessionForCreate" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ExternalFormFillSession" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateExternalFormFillSession", "x-ds-method": "CreateExternalFormFillSession", "x-ds-service": "ExternalFormFillSessions", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/field_sets/{fieldSetId}": { "get": { "tags": [ "Fields" ], "summary": "Gets a field set.", "description": "Returns a field set. This is a set of fields that can appear on a room's Details tab in the console, such as `contactName` and `phone`.", "operationId": "Fields_GetFieldSet", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "fieldSetId", "description": "The ID of the field set.\n\nExample: `4aef602b-xxxx-xxxx-xxxx-08d76696f678`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fieldsCustomDataFilters", "description": "An comma-separated list that limits the fields to return:\n\n- `IsRequiredOnCreate`: include fields that are required in room creation.\n- `IsRequiredOnSubmit`: include fields that are required when submitting a room for review.\n", "type": "array", "items": { "enum": [ "None", "IsRequiredOnCreate", "IsRequiredOnSubmit" ], "type": "string" } }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "FieldSet successfully retrieved.", "schema": { "$ref": "#/definitions/FieldSet" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFieldSet", "x-ds-method": "GetFieldSet", "x-ds-service": "Fields", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups": { "get": { "tags": [ "FormGroups" ], "summary": "Gets form groups.", "description": "Returns the company form groups to which the current user has access.\n\n## Permissions \n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_GetFormGroups", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position of the results set. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved Form Groups.", "schema": { "$ref": "#/definitions/FormGroupSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormGroups", "x-ds-method": "GetFormGroups", "x-ds-service": "FormGroups", "x-ds-in-sdk": true }, "post": { "tags": [ "FormGroups" ], "summary": "Creates a form group.", "description": "Creates a new form group with the name given in the `name` property of the request body.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_CreateFormGroup", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/FormGroupForCreate" } } ], "responses": { "201": { "description": "Successfully created form group.", "schema": { "$ref": "#/definitions/FormGroup" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateFormGroup", "x-ds-method": "CreateFormGroup", "x-ds-service": "FormGroups", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups/{formGroupId}": { "get": { "tags": [ "FormGroups" ], "summary": "Gets a form group.", "description": "Get the specified form group.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_GetFormGroup", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved form group.", "schema": { "$ref": "#/definitions/FormGroup" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormGroup", "x-ds-method": "GetFormGroup", "x-ds-service": "FormGroups", "x-ds-in-sdk": true }, "put": { "tags": [ "FormGroups" ], "summary": "Renames a form group.", "description": "Renames the specified form group with the name given in the `name` property of the request.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_RenameFormGroup", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/FormGroupForUpdate" } } ], "responses": { "200": { "description": "Successfully updated form group.", "schema": { "$ref": "#/definitions/FormGroup" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RenameFormGroup", "x-ds-method": "RenameFormGroup", "x-ds-service": "FormGroups", "x-ds-in-sdk": true }, "delete": { "tags": [ "FormGroups" ], "summary": "Deletes a form group.", "description": "Deletes the specified form group.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_DeleteFormGroup", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successfully deleted form group." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteFormGroup", "x-ds-method": "DeleteFormGroup", "x-ds-service": "FormGroups", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups/{formGroupId}/forms": { "get": { "tags": [ "FormGroups" ], "summary": "Gets the user's form group forms.\n", "description": "Get forms of the specified form group.", "operationId": "FormGroupForms_GetFormGroupForms", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "count", "description": "The number of results to return. \nDefault value is 100 and max value is 100\n", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The starting point of the list. The default is 0.\n", "type": "integer", "format": "int32", "default": 0 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved form group's forms.", "schema": { "$ref": "#/definitions/FormGroupFormList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormGroupForms", "x-ds-method": "GetFormGroupForms", "x-ds-service": "FormGroupForms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups/{formGroupId}/unassign_form/{formId}": { "post": { "tags": [ "FormGroups" ], "summary": "Removes a form from a form group.", "description": "Removes the form `formId` from the form group `formGroupId`.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_RemoveFormGroupForm", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "formId", "description": "The ID of the form.", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Form was successfully removed from the form group" }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RemoveFormGroupForm", "x-ds-method": "RemoveFormGroupForm", "x-ds-service": "FormGroups", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups/{formGroupId}/assign_form": { "post": { "tags": [ "FormGroups" ], "summary": "Assigns a form to a form group.", "description": "Assigns the form specified in the `formId` property of the request to the form group `formGroupId`. Set the `isRequired` property in the request body to **true** if this is a required form.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**\n", "operationId": "FormGroups_AssignFormGroupForm", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/FormGroupFormToAssign" } } ], "responses": { "204": { "description": "Successfully assigned form to form group.", "schema": { "$ref": "#/definitions/FormGroupFormToAssign" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "AssignFormGroupForm", "x-ds-method": "AssignFormGroupForm", "x-ds-service": "FormGroups", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups/{formGroupId}/grant_office_access/{officeId}": { "post": { "tags": [ "FormGroups" ], "summary": "Grants an office access to a form group.", "description": "Grants the office `officeId` access to the form group `formGroupId`.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_GrantOfficeAccessToFormGroup", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "officeId", "description": "The ID of the office. This is the ID that the system generated when you created the office.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Office was successfully assigned to the form group" }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GrantOfficeAccessToFormGroup", "x-ds-method": "GrantOfficeAccessToFormGroup", "x-ds-service": "FormGroups", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_groups/{formGroupId}/revoke_office_access/{officeId}": { "post": { "tags": [ "FormGroups" ], "summary": "Revoke an office's access to a form group.", "description": "Revoke access to the form group `formGroupId` from the office `officeId`.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**", "operationId": "FormGroups_RevokeOfficeAccessFromFormGroup", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formGroupId", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "officeId", "description": "The ID of the office. This is the ID that the system generated when you created the office.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Office was successfully removed from the form group" }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RevokeOfficeAccessFromFormGroup", "x-ds-method": "RevokeOfficeAccessFromFormGroup", "x-ds-service": "FormGroups", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_libraries": { "get": { "tags": [ "FormLibraries" ], "summary": "Gets form libraries.", "description": "Returns a list of form libraries to which the current user has access.\n\n## Permissions\n\nAll users can use this method, but the results will differ based on whether the company has asked DocuSign to enable **RequireOfficeLibraryAssignments** functionality. If this functionality is enabled for the account, then the list is filtered based on the offices that the user is in and the libraries that are assigned to those offices. When **RequireOfficeLibraryAssignments** is not enabled, the API returns all results.", "operationId": "FormLibraries_GetFormLibraries", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position of the results set. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved Form Libraries.", "schema": { "$ref": "#/definitions/FormLibrarySummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormLibraries", "x-ds-method": "GetFormLibraries", "x-ds-service": "FormLibraries", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_libraries/{formLibraryId}/forms": { "get": { "tags": [ "FormLibraries" ], "summary": "Gets the forms in a form library.", "description": "Returns a list of forms to which the current user has access in the specified form library.", "operationId": "FormLibraries_GetFormLibraryForms", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formLibraryId", "description": "The ID of the form library.\n\nExample: `402c6e2f-xxxx-xxxx-xxxx-ff3f249f6da9`\n", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "(Optional) The starting zero-based index position of the results set. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved library forms.", "schema": { "$ref": "#/definitions/FormSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormLibraryForms", "x-ds-method": "GetFormLibraryForms", "x-ds-service": "FormLibraries", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/form_providers/{providerId}/associations": { "get": { "tags": [ "FormProviders" ], "summary": "Gets all associations by provider.\n", "description": "Gets all associations by provider.\n", "operationId": "FormProviderAssociations_GetFormProviderAssociations", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "providerId", "description": "The provider ID.\n\n", "required": true, "type": "string" }, { "in": "query", "name": "count", "description": "The total number of associations to be returned.\n", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The starting position on the list.\n", "type": "integer", "format": "int32", "default": 0 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved Form Associations by provider type.", "schema": { "$ref": "#/definitions/FormProviderAssociationsSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormProviderAssociations", "x-ds-method": "GetFormProviderAssociations", "x-ds-service": "FormProviderAssociations", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/forms/{formId}/details": { "get": { "tags": [ "FormDetails" ], "summary": "Gets form details.", "description": "Returns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.", "operationId": "FormDetails_GetFormDetails", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "formId", "description": "The ID of the form.", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Form based on FormId", "schema": { "$ref": "#/definitions/FormDetails" } }, "400": { "description": "Unable to Find Form based on FormId" }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFormDetails", "x-ds-method": "GetFormDetails", "x-ds-service": "FormDetails", "x-ds-in-sdk": true } }, "/v2/countries": { "get": { "tags": [ "Countries" ], "summary": "Gets countries.", "description": "Returns a list of countries that the API supports. This is a list of countries in which you can create an office.\n\nYou do not specify an `accountId` or any other parameters with this method.\n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "Countries_GetCountries", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalCountries" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetCountries", "x-ds-method": "GetCountries", "x-ds-service": "Countries", "x-ds-in-sdk": true } }, "/v2/closing_statuses": { "get": { "tags": [ "ClosingStatuses" ], "summary": "Gets closing statuses.", "description": "Returns a list of closing statuses, or valid reasons for closing a room.\n\nYou do not specify an `accountId` or any other parameters with this method.\n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "ClosingStatuses_GetClosingStatuses", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalClosingStatuses" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetClosingStatuses", "x-ds-method": "GetClosingStatuses", "x-ds-service": "ClosingStatuses", "x-ds-in-sdk": true } }, "/v2/contact_sides": { "get": { "tags": [ "ContactSides" ], "summary": "Gets contact sides.", "description": "Return a list of valid values for transaction contact sides.\n\n**Note:** You do not specify an `accountId` or any other parameters with this method.\n\n## Permissions\n\nAny user who has a valid access token can use this method.", "operationId": "ContactSides_GetContactSides", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalContactSides" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetContactSides", "x-ds-method": "GetContactSides", "x-ds-service": "ContactSides", "x-ds-in-sdk": true } }, "/v2/financing_types": { "get": { "tags": [ "FinancingTypes" ], "summary": "Gets financing types.", "description": "Returns a list of possible financing types.\n\n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "FinancingTypes_GetFinancingTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalFinancingTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetFinancingTypes", "x-ds-method": "GetFinancingTypes", "x-ds-service": "FinancingTypes", "x-ds-in-sdk": true } }, "/v2/origins_of_leads": { "get": { "tags": [ "OriginsOfLeads" ], "summary": "Gets origins of leads.", "description": "Returns a list of origins of leads (such as Trulia or Zillow) that you can specify for rooms.\n\n## Permissions\n\nAnyone with a valid access token can call this method.", "operationId": "OriginsOfLeads_GetOriginsOfLeads", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalOriginsOfLeads" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetOriginsOfLeads", "x-ds-method": "GetOriginsOfLeads", "x-ds-service": "OriginsOfLeads", "x-ds-in-sdk": true } }, "/v2/property_types": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets property types.", "description": "Returns a list of property types.\n\n## Permissions\n\nAnyone with a valid access token can call this method.", "operationId": "PropertyTypes_GetPropertyTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalPropertyTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetPropertyTypes", "x-ds-method": "GetPropertyTypes", "x-ds-service": "PropertyTypes", "x-ds-in-sdk": true } }, "/v2/room_contact_types": { "get": { "tags": [ "RoomContactTypes" ], "summary": "Gets room contact types.", "description": "Returns a list of room contact types, such as Buyer, Seller, and Listing Agent.\n\n## Permissions\n\nAnyone with a valid access token can call this method.", "operationId": "RoomContactTypes_GetRoomContactTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalRoomContactTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoomContactTypes", "x-ds-method": "GetRoomContactTypes", "x-ds-service": "RoomContactTypes", "x-ds-in-sdk": true } }, "/v2/seller_decision_types": { "get": { "tags": [ "SellerDecisionTypes" ], "summary": "Gets seller decision types.", "description": "Returns a list of possible seller decision types regarding offers, such as `Countered` or `Rejected`.\n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "SellerDecisionTypes_GetSellerDecisionTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalSellerDecisionTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetSellerDecisionTypes", "x-ds-method": "GetSellerDecisionTypes", "x-ds-service": "SellerDecisionTypes", "x-ds-in-sdk": true } }, "/v2/special_circumstance_types": { "get": { "tags": [ "SpecialCircumstanceTypes" ], "summary": "Gets special circumstance types.", "description": "Returns a list of special circumstance types, such as `Short Sale` and `Foreclosure`. These are the values that you can select for the **Special circumstances** field that appears on the **Room Details** page.\n\n## Permissions\n\nAnyone with a valid access token can call this method.", "operationId": "SpecialCircumstanceTypes_GetSpecialCircumstanceTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalSpecialCircumstanceTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetSpecialCircumstanceTypes", "x-ds-method": "GetSpecialCircumstanceTypes", "x-ds-service": "SpecialCircumstanceTypes", "x-ds-in-sdk": true } }, "/v2/task_date_types": { "get": { "tags": [ "TaskDateTypes" ], "summary": "Gets task date types.", "description": "Returns a list of date types that you can use with tasks, such as `Actual Close Date` and `Task Due Date`. These are the options that appear in the **Due Date** drop-down list when you create a task by using the console.\n\n**Note:** You do not enter an `accountId` with this method.\n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "TaskDateTypes_GetTaskDateTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalTaskDateTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTaskDateTypes", "x-ds-method": "GetTaskDateTypes", "x-ds-service": "TaskDateTypes", "x-ds-in-sdk": true } }, "/v2/task_responsibility_types": { "get": { "tags": [ "TaskResponsibilityTypes" ], "summary": "Gets task responsibility types.", "description": "Returns a list of responsibility types that you can assign to users when you add them to a task. \n\n**Note:** You do not specify an `accountId` with this method.\n\n## Permissions\n\nAny user with a valid access token can call this method.", "operationId": "TaskResponsibilityTypes_GetTaskResponsibilityTypes", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalTaskResponsibilityTypes" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTaskResponsibilityTypes", "x-ds-method": "GetTaskResponsibilityTypes", "x-ds-service": "TaskResponsibilityTypes", "x-ds-in-sdk": true } }, "/v2/task_statuses": { "get": { "tags": [ "TaskStatuses" ], "summary": "Retrieves the list of valid task statuses.", "description": "Returns a list of valid task statuses.", "operationId": "TaskStatuses_GetTaskStatuses", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalTaskStatuses" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTaskStatuses", "x-ds-method": "GetTaskStatuses", "x-ds-service": "TaskStatuses", "x-ds-in-sdk": true } }, "/v2/transaction_sides": { "get": { "tags": [ "TransactionSides" ], "summary": "Gets transaction sides.", "description": "Returns a list of real estate transaction sides. \n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "TransactionSides_GetTransactionSides", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalTransactionSides" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTransactionSides", "x-ds-method": "GetTransactionSides", "x-ds-service": "TransactionSides", "x-ds-in-sdk": true } }, "/v2/states": { "get": { "tags": [ "States" ], "summary": "Gets states.", "description": "Returns a list of states.\n\n**Note:** You do not enter an `accountId` with this method.\n\n## Permissions\n\nAnyone with a valid access token can call this method.", "operationId": "States_GetStates", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalStates" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetStates", "x-ds-method": "GetStates", "x-ds-service": "States", "x-ds-in-sdk": true } }, "/v2/currencies": { "get": { "tags": [ "Currencies" ], "summary": "Gets valid currencies.", "description": "Returns a list of valid values for the currencies that you can use for listing, offer, and loan amounts.\n\n**Note:** You do not specify an `accountId` with this method.\n\n## Permissions\n\nAny user with a valid access token can use this method.", "operationId": "Currencies_GetCurrencies", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalCurrencies" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetCurrencies", "x-ds-method": "GetCurrencies", "x-ds-service": "Currencies", "x-ds-in-sdk": true } }, "/v2/time_zones": { "get": { "tags": [ "TimeZones" ], "summary": "Gets time zones.", "description": "Gets a list of time zones that you can assign to an office.\n\n**Note:** You do not specify an `accountId` with this method.\n\n## Permissions\n\nAnyone with a valid access token can call this method.", "operationId": "TimeZones_GetTimeZones", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "Request was successful.", "schema": { "$ref": "#/definitions/GlobalTimeZones" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTimeZones", "x-ds-method": "GetTimeZones", "x-ds-service": "TimeZones", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/offices": { "get": { "tags": [ "Offices" ], "summary": "Gets offices.", "description": "This method returns a list of offices associated with an account.", "operationId": "Offices_GetOffices", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position of the results set from which to begin returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "onlyAccessible", "description": "When **true,** the response only includes the offices that are accessible to the current user.", "type": "boolean", "default": false }, { "in": "query", "name": "search", "description": "Filters returned records by the specified string. The response only includes records containing this string in the office `name` field.", "type": "string" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Offices successfully retrieved.", "schema": { "$ref": "#/definitions/OfficeSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetOffices", "x-ds-method": "GetOffices", "x-ds-service": "Offices", "x-ds-in-sdk": true }, "post": { "tags": [ "Offices" ], "summary": "Creates an office.", "description": "This method creates an office in a Rooms account. You can configure the following information for the new office:\n\n- Office name\n- Region\n- Address\n- Country ID and time zone\n- Phone number\n\nWhen you create an office, the Rooms API service assigns it an ID (`officeId`) and timestamp (`createdDate`), which are returned in the response along with the above data elements you specified. See the `Offices` object for descriptions of these data elements.\n\nUse the [Users: AddUserToOffice](/docs/rooms-api/reference/users/users/addusertooffice/)\nmethod to add users to the office.", "operationId": "Offices_CreateOffice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/OfficeForCreate" } } ], "responses": { "201": { "description": "Office successfully created.", "schema": { "$ref": "#/definitions/Office" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateOffice", "x-ds-method": "CreateOffice", "x-ds-service": "Offices", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/offices/{officeId}": { "get": { "tags": [ "Offices" ], "summary": "Gets information about an office.", "description": "This method returns information about an office.", "operationId": "Offices_GetOffice", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "officeId", "description": "The ID of the office.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Office successfully retrieved.", "schema": { "$ref": "#/definitions/Office" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetOffice", "x-ds-method": "GetOffice", "x-ds-service": "Offices", "x-ds-in-sdk": true }, "delete": { "tags": [ "Offices" ], "summary": "Deletes an office.", "description": "This method deletes an office from a Rooms account.", "operationId": "Offices_DeleteOffice", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "officeId", "description": "The ID of the office.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Office successfully deleted." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteOffice", "x-ds-method": "DeleteOffice", "x-ds-service": "Offices", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/offices/{officeId}/reference_counts": { "get": { "tags": [ "Offices" ], "summary": "Retrieves the number and type of objects that reference an office.", "description": "This method returns a list of each type of object and the number of objects of that type referencing the specified office. Note that an office cannot be deleted while existing objects reference it.", "operationId": "Offices_GetReferenceCounts", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "officeId", "description": "The ID of the office.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Reference counts successfully retrieved.", "schema": { "$ref": "#/definitions/OfficeReferenceCountList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetReferenceCounts", "x-ds-method": "GetReferenceCounts", "x-ds-service": "Offices", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/regions": { "post": { "tags": [ "Regions" ], "summary": "Creates a region.", "description": "This method creates a new region. When you create a region, you specify only the name. The service will assign and return a region ID (`regionId`) and a creation timestamp (`createdDate`).", "operationId": "Regions_CreateRegion", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/Region" } } ], "responses": { "201": { "description": "The region was successfully created", "schema": { "$ref": "#/definitions/Region" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateRegion", "x-ds-method": "CreateRegion", "x-ds-service": "Regions", "x-ds-in-sdk": true }, "get": { "tags": [ "Regions" ], "summary": "Gets regions.", "description": "This method returns a list of regions that are associated with a Rooms account.", "operationId": "Regions_GetRegions", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position of the results set from which to begin returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "managedOnly", "description": "When **true,** only the regions that the current user manages are returned. The default value is **false.**", "type": "boolean", "default": false }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Regions successfully retrieved.", "schema": { "$ref": "#/definitions/RegionSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRegions", "x-ds-method": "GetRegions", "x-ds-service": "Regions", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/regions/{regionId}": { "get": { "tags": [ "Regions" ], "summary": "Gets information about a region.", "description": "This method returns information about a specific region.", "operationId": "Regions_GetRegion", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "regionId", "description": "The ID of the region.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The region was found.", "schema": { "$ref": "#/definitions/Region" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRegion", "x-ds-method": "GetRegion", "x-ds-service": "Regions", "x-ds-in-sdk": true }, "delete": { "tags": [ "Regions" ], "summary": "Deletes a region.", "description": "This method deletes a region from a Rooms account.", "operationId": "Regions_DeleteRegion", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "regionId", "description": "The ID of the region.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Region successfully deleted." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteRegion", "x-ds-method": "DeleteRegion", "x-ds-service": "Regions", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/regions/{regionId}/reference_counts": { "get": { "tags": [ "Regions" ], "summary": "Retrieves the number and type of objects that reference a region.", "description": "This method returns a list of each type of object and the number of objects of that type referencing the specified region. \n\n**Note:** A region cannot be deleted while existing objects reference it.", "operationId": "Regions_GetRegionReferenceCounts", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "regionId", "description": "The ID of the region.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Reference counts successfully retrieved.", "schema": { "$ref": "#/definitions/RegionReferenceCountList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRegionReferenceCounts", "x-ds-method": "GetRegionReferenceCounts", "x-ds-service": "Regions", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/roles": { "post": { "tags": [ "Roles" ], "summary": "Creates a role.", "description": "Creates a new company role.\n\n## Permissions\n\nTo use this method, you must have the `canManageAccount` permission set to **true.**", "operationId": "Roles_CreateRole", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/RoleForCreate" } } ], "responses": { "201": { "description": "Role successfully created.", "schema": { "$ref": "#/definitions/Role" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateRole", "x-ds-method": "CreateRole", "x-ds-service": "Roles", "x-ds-in-sdk": true }, "get": { "tags": [ "Roles" ], "summary": "Gets roles.", "description": "Returns a list of roles associated with a company account.\n\n## Permissions \n\nAny user with a valid access token can call this method.", "operationId": "Roles_GetRoles", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "onlyAssignable", "description": "This parameter is deprecated. Use `filterContext` instead. Note that `filterContext=AssignableRolesBasedOnCompanyPermissions` is equivalent to `onlyAssignable=true`.", "type": "boolean", "default": false }, { "in": "query", "name": "filterContext", "description": "Filters the roles by the calling user's permissions. Valid values are:\n\n- `AllRoles` (default): All roles are returned.\n- `AssignableRolesBasedOnAllPermissions`: Only roles that the current user can assign to someone else are returned. In other words, given the permission set of the current user, only roles with a subset of those permissions (including the same exact permissions) will be returned.\n- `AssignableRolesBasedOnCompanyPermissions`: Only roles that the current user can assign to someone else based on company permissions are returned. Other permissions are not taken into account. In other words, given the company permissions of the current user, only roles with a subset of those company permissions (including the same exact company permissions) will be returned." }, { "in": "query", "name": "filter", "description": "A search filter that returns roles by the beginning of the role name. You can enter the beginning of the role name only to return all of the roles that begin with the text that you entered. \n\nFor example, if your company has set up roles such as Manager Beginner, Manager Pro, Agent Expert, and Agent Superstar, you could enter `Manager` to return all of the Manager roles (Manager Beginner and Manager Pro).\n\n**Note:** You do not enter a wildcard (*) at the end of the name fragment.", "type": "string" }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position of the result set. The default value is 0.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Roles successfully retrieved.", "schema": { "$ref": "#/definitions/RoleSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoles", "x-ds-method": "GetRoles", "x-ds-service": "Roles", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/roles/{roleId}": { "get": { "tags": [ "Roles" ], "summary": "Gets a role.", "description": "Returns details about a role, including the associated permissions.", "operationId": "Roles_GetRole", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roleId", "description": "The ID of the role.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeIsAssigned", "description": "When **true,** the response includes the `isAssigned` property, which specifies whether the role is currently assigned to any users. The default is **false.**", "type": "boolean", "default": false }, { "in": "path", "name": "accountId", "description": "(Required) The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Role successfully retrieved.", "schema": { "$ref": "#/definitions/Role" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRole", "x-ds-method": "GetRole", "x-ds-service": "Roles", "x-ds-in-sdk": true }, "put": { "tags": [ "Roles" ], "summary": "Updates a role.", "description": "Modifies the specified company role.\n\n## Permissions\n\nTo use this method, you must have the `canManageAccount` permission set to **true.**", "operationId": "Roles_UpdateRole", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roleId", "description": "The ID of the role.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/RoleForUpdate" } } ], "responses": { "200": { "description": "Role successfully updated.", "schema": { "$ref": "#/definitions/Role" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "UpdateRole", "x-ds-method": "UpdateRole", "x-ds-service": "Roles", "x-ds-in-sdk": true }, "delete": { "tags": [ "Roles" ], "summary": "Deletes a role.", "description": "Deletes a role from a company account.\n\n## Permissions \n\nTo use this method, you must have the `canManageAccount` permission set to **true.**", "operationId": "Roles_DeleteRole", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roleId", "description": "The ID of the role to delete.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Role successfully deleted." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteRole", "x-ds-method": "DeleteRole", "x-ds-service": "Roles", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/envelopes": { "post": { "tags": [ "Rooms" ], "summary": "Creates an envelope with the given documents. Returns the eSignature envelope ID of the envelope that was created.\n", "description": "Creates an envelope with the given documents. Returns the eSignature envelope ID of the envelope that was created.\n", "operationId": "RoomEnvelopes_CreateRoomEnvelope", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The room ID.\n", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/EnvelopeForCreate" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Envelope" } }, "201": { "description": "The envelope was successfully created.", "schema": { "$ref": "#/definitions/Envelope" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateRoomEnvelope", "x-ds-method": "CreateRoomEnvelope", "x-ds-service": "RoomEnvelopes", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/field_data": { "get": { "tags": [ "Rooms" ], "summary": "Gets a room's field data.", "description": "Returns the field data associated with a room. This is the information that appears on the room's **Details** tab.\n\nTo better understand the room's field data, use\nthe [Rooms: GetRoomFieldSet](/docs/rooms-api/reference/rooms/rooms/getroomfieldset/) method to retrieve the set of fields that the room uses.", "operationId": "Rooms_GetRoomFieldData", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Field data successfully retrieved.", "schema": { "$ref": "#/definitions/FieldData" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoomFieldData", "x-ds-method": "GetRoomFieldData", "x-ds-service": "Rooms", "x-ds-in-sdk": true }, "put": { "tags": [ "Rooms" ], "summary": "Updates a room's field data.", "description": "This method lets you update one or more fields in a room's field data, the information that appears in the room's **Details** tab.\nTo better understand the room's field data,\nuse the [Rooms: GetRoomFieldSet](/docs/rooms-api/reference/rooms/rooms/getroomfieldset/) method to retrieve the set of fields that the room uses.\n\nTo get the current values of a room's field data,\nuse [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfieldset/).\n\nFor example, to update the \"Tax annual amount\" and Buyer1's name fields in a room, you would use a request body that looks like this:\n\n```\n{\n \"data\": {\n \"taxAnnualAmount\": 3389.12,\n \"buyer1\": {\n \"name\": \"Elizabeth Bennet\"\n }\n }\n}\n```\n\nIf successful, the response body will have the same contents as the request body.\n\n\nAll of the fields must be updated successfully for the method to succeed.\nFor example, if you were to set the tax amount to a negative number,\nthe method will fail and none of the fields will be updated.", "operationId": "Rooms_UpdateRoomFieldData", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/FieldDataForUpdate" } } ], "responses": { "200": { "description": "Field data successfully updated.", "schema": { "$ref": "#/definitions/FieldData" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "UpdateRoomFieldData", "x-ds-method": "UpdateRoomFieldData", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/room_folders": { "get": { "tags": [ "RoomFolders" ], "summary": "Gets a list of room folders accessible to the current user.", "description": "Gets a list of room folders in the specified room that are accessible to the current user.", "operationId": "RoomFolders_GetRoomFolders", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room from which to retrieve folders.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "count", "description": "The number of results. When this property is used as a request parameter specifying the number of results to return, the value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Room folders successfully retrieved.", "schema": { "$ref": "#/definitions/RoomFolderList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoomFolders", "x-ds-method": "GetRoomFolders", "x-ds-service": "RoomFolders", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/forms": { "post": { "tags": [ "Rooms" ], "summary": "Adds a form to a room.", "description": "Adds a form to a room.\n\nYou specify the form that you want to add in the `formForAdd` request body. To find the ID of the form that you want to add, use the [FormsLibraries: GetFormLibraryForms method][GetFormLibraryForms].\n\n[GetFormLibraryForms]: /docs/rooms-api/reference/Forms/FormLibraries/GetFormLibraryForms/\n## Permissions\n\nYou must have a role for which the `canAddDocumentsFromFormLibraries` permission is set to **true.**", "operationId": "Rooms_AddFormToRoom", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/FormForAdd" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RoomDocument" } }, "201": { "description": "The DocuSign Form was successfully added to the room", "schema": { "$ref": "#/definitions/RoomDocument" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "AddFormToRoom", "x-ds-method": "AddFormToRoom", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/users": { "post": { "tags": [ "Rooms" ], "summary": "Invites a user to a room.", "description": "This method invites an existing or new member to a specific room.\n\nYou can invite anyone to join a room by specifying their email address.", "operationId": "Rooms_InviteUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/RoomInvite" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/RoomInviteResponse" } }, "201": { "description": "The user was successfully invited to the room.", "schema": { "$ref": "#/definitions/RoomInviteResponse" } }, "400": { "description": "The user could not be invited to the room.", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "InviteUser", "x-ds-method": "InviteUser", "x-ds-service": "Rooms", "x-ds-in-sdk": true }, "get": { "tags": [ "Rooms" ], "summary": "Gets a room's users.", "description": "This method returns a list of users associated with a room.", "operationId": "Rooms_GetRoomUsers", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The index position within the total result set from which to start returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "filter", "description": "A search filter that returns users by the beginning of the user's first name, last name, or email address. You can enter the beginning of the name or email only to return all of the users whose names or email addresses begin with the text that you entered. \n\n**Note:** You do not enter a wildcard (*) at the end of the name or email fragment.", "type": "string" }, { "in": "query", "name": "sort", "description": "The order in which to return results. Valid values are:\n\n- `firstNameAsc`: Sort on first name in ascending order. \n- `firstNameDesc`: Sort on first name in descending order. \n- `lastNameAsc`: Sort on last name in ascending order. \n- `lastNameDesc`: Sort on last name in descending order. This is the default value." }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The room user was successfully retrieved.", "schema": { "$ref": "#/definitions/RoomUsersResult" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } }, "404": { "description": "The room was not found." } }, "x-ds-methodname": "GetRoomUsers", "x-ds-method": "GetRoomUsers", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}": { "put": { "tags": [ "Rooms" ], "summary": "Updates a room user.", "description": "You can use this method to update the following information for a room user:\n\n- `roleId`\n- `transactionSideId`\n\nIn the console, this is the **Side and role** information that appears in the room's **People** tab. You specify the information that you want to update in the `roomUserForUpdate` request body.\n\n## Permissions\n\nOnly the person who invited the room user to the room can update the room user.", "operationId": "Rooms_PutRoomUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "userId", "description": "The ID of the user to update.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/RoomUserForUpdate" } } ], "responses": { "200": { "description": "The room user was successfully updated.", "schema": { "$ref": "#/definitions/RoomUser" } }, "400": { "description": "The room user could not be updated.", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "PutRoomUser", "x-ds-method": "PutRoomUser", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access": { "post": { "tags": [ "Rooms" ], "summary": "Revokes the specified user's access to the room.", "description": "Revokes the specified user's access to the room. If successful, the HTTP result is 204 (No content), and the response is empty.\n\nTo revoke access immediately, leave the request body empty.\n\nTo revoke access on a specific date, use the request body to specify a date. \n\n**Note** If a user doesn't have access to a room, and you revoke their access at a future date, the user will be granted access until the revocation date.", "operationId": "Rooms_RevokeRoomUserAccess", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "userId", "description": "The ID of the user whose access you want to revoke.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/RoomUserRemovalDetail" } } ], "responses": { "204": { "description": "The room user's access was successfully revoked." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RevokeRoomUserAccess", "x-ds-method": "RevokeRoomUserAccess", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/restore_access": { "post": { "tags": [ "Rooms" ], "summary": "Restores the specified user's access to the room.", "description": "Restores the specified user's access to the room.", "operationId": "Rooms_RestoreRoomUserAccess", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "userId", "description": "The ID of the user to restore to the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "The room user's access was successfully restored." }, "400": { "description": "The room user's access could not be restored.", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RestoreRoomUserAccess", "x-ds-method": "RestoreRoomUserAccess", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms": { "get": { "tags": [ "Rooms" ], "summary": "Returns a list of rooms.", "description": "This method returns details about the rooms that the current user has permissions to view.\n\nThe `fieldDataChangedStartDate` and `fieldDataChangedEndDate`\nquery parameters let you limit the results to rooms\nwhose [field data](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/) has changed within a range of dates.\n\nThe `roomClosedStartDate` and `roomClosedEndDate` query parameters let you limit the results to rooms that were closed within a range of dates.\n\n**Note:** By default, this method only returns open rooms. To return other rooms, use the `roomStatus` query parameter.", "operationId": "Rooms_GetRooms", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "count", "description": "The number of results. When this property is used as a request parameter specifying the number of results to return, the value must be a number between 1 and 100 (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The index position within the total result set from which to start returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "roomStatus", "description": "The status of the room. Valid values are:\n\n- `active`: This is the default value.\n- `pending`\n- `open`: Includes both `active` and `pending` statuses.\n- `closed`\n\nTo return rooms with multiple statuses, enter a comma-separated list of statuses. \n\nExample:\n\n`closed,open`" }, { "in": "query", "name": "officeId", "description": "The ID of the office.", "type": "integer", "format": "int32" }, { "in": "query", "name": "fieldDataChangedStartDate", "description": "Starting date and time to filter rooms whose field data has changed after this date. Date and time is always given as UTC. If the time (`hh:mm:ss`) is omitted, it defaults to `00:00:00`.\n\nValid formats:\n\n- `yyyy-mm-dd hh:mm:ss`\n- `yyyy/mm/dd hh:mm:ss`\n\nThe default start date is the beginning of time.\n", "type": "string" }, { "in": "query", "name": "fieldDataChangedEndDate", "description": "Ending date and time to filter rooms whose field data has changed before this date. Date and time is always given as UTC. If the time (`hh:mm:ss`) is omitted, it defaults to `00:00:00`.\n\n\nValid formats:\n\n- `yyyy-mm-dd hh:mm:ss`\n- `yyyy/mm/dd hh:mm:ss`\n\nIf this query parameter is omitted, the default end date is now.\n", "type": "string" }, { "in": "query", "name": "roomClosedStartDate", "description": "Starting date and time to filter rooms that were closed this date. Date and time is always given as UTC. If the time (`hh:mm:ss`) is omitted, it defaults to `00:00:00`.\n\nValid formats:\n\n- `yyyy-mm-dd hh:mm:ss`\n- `yyyy/mm/dd hh:mm:ss`\n\nThe default start date is the beginning of time.\n", "type": "string" }, { "in": "query", "name": "roomClosedEndDate", "description": "Ending date and time to filter rooms that were closed before this date. Date and time is always given as UTC. If the time (`hh:mm:ss`) is omitted, it defaults to `00:00:00`.\n\nValid formats:\n\n- `yyyy-mm-dd hh:mm:ss`\n- `yyyy/mm/dd hh:mm:ss`\n\nIf this query parameter is omitted, the default end date is now.", "type": "string" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Rooms successfully retrieved.", "schema": { "$ref": "#/definitions/RoomSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRooms", "x-ds-method": "GetRooms", "x-ds-service": "Rooms", "x-ds-in-sdk": true }, "post": { "tags": [ "Rooms" ], "summary": "Creates a room.", "description": "This method creates a new room.\n\n**Note:** To use this method, your company must have at least one office set up.\n\n## Permissions\n\nYou must be assigned to a role that has the **Create Rooms** permission set to **true.**", "operationId": "Rooms_CreateRoom", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/RoomForCreate" } } ], "responses": { "201": { "description": "Room successfully created.", "schema": { "$ref": "#/definitions/Room" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateRoom", "x-ds-method": "CreateRoom", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}": { "get": { "tags": [ "Rooms" ], "summary": "Gets a room.", "description": "This method returns details about a specific room.", "operationId": "Rooms_GetRoom", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeFieldData", "description": "When **true,** the response includes the field data from the room. This is the information that appears on the room's **Details** tab.", "type": "boolean", "default": false }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Room successfully retrieved.", "schema": { "$ref": "#/definitions/Room" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoom", "x-ds-method": "GetRoom", "x-ds-service": "Rooms", "x-ds-in-sdk": true }, "delete": { "tags": [ "Rooms" ], "summary": "Deletes a room.", "description": "This method deletes a room.\n\n**Note:** To use this method, you must be assigned a role that has the **Delete Owned Rooms** permission set to **true** in the console. If you manage other members, this permission also enables you to delete rooms that are owned by the users that you manage.", "operationId": "Rooms_DeleteRoom", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Room successfully deleted." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteRoom", "x-ds-method": "DeleteRoom", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles": { "get": { "tags": [ "Rooms" ], "summary": "Gets assignable room-level roles in v6.", "description": "This method returns the room-level roles that the current user can assign to the members that they invite to a room.\n\n**Note:** This method works only for Rooms v6 and only returns roles that have `isExternal` set to **true.**", "operationId": "Rooms_GetAssignableRoles", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "assigneeEmail", "description": "The email address of a specific member. Using this parameter returns only the roles that the current user can assign to the member with that email address.", "type": "string" }, { "in": "query", "name": "filter", "description": "A search filter that returns assignable roles by the beginning of the role name.\n\n**Note:** You do not enter a wildcard (*) at the end of the name fragment.", "type": "string" }, { "in": "query", "name": "startPosition", "description": "The index position within the total result set from which to start returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Assignable roles successfully retrieved.", "schema": { "$ref": "#/definitions/AssignableRoles" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetAssignableRoles", "x-ds-method": "GetAssignableRoles", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/documents": { "post": { "tags": [ "Rooms" ], "summary": "Adds a document to a room.", "description": "Adds a document to a room.\n\nThe following properties in the request body are required. The `folderId` property is optional. All other properties are ignored.\n\n- `name`\n- `base64Contents`\n\nIf a document with the specified name already exists, a counter is added to the name to make it unique.\n\nFor example, to create a document named **hello.txt** that contains the text `hello, world`, the body of your request would look like this:\n\n```\n{\n \"name\": \"hello.txt\",\n \"base64Contents\": \"aGVsbG8sIHdvcmxkCg==\"\n}\n```\n\n", "operationId": "Rooms_AddDocumentToRoom", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/Document" } } ], "responses": { "201": { "description": "Document successfully added.", "schema": { "$ref": "#/definitions/RoomDocument" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "AddDocumentToRoom", "x-ds-method": "AddDocumentToRoom", "x-ds-service": "Rooms", "x-ds-in-sdk": true }, "get": { "tags": [ "Rooms" ], "summary": "Gets a list of documents in a room.", "description": "This method returns a list of documents that the current user can access for a specific room.", "operationId": "Rooms_GetDocuments", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The index position within the total result set from which to start returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "requireContentForDynamicDocuments", "description": "When **true,** dynamic documents without content will not be returned. The default value is **false.**", "type": "boolean", "default": false }, { "in": "query", "name": "roomFolderId", "description": "Filters results by `folderId`. If this property is not set, no filtering is applied.", "type": "integer", "format": "int32" }, { "in": "query", "name": "nameFilter", "description": "Filters results by `name`. If this property is not set, no filtering is applied.", "type": "string" }, { "in": "query", "name": "includeArchived", "description": "Filters results by `isArchived`. For example, when **true,** only documents with the property `isArchived=true` will be returned. If this property is not set, no filtering is applied.", "type": "boolean", "default": true }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Documents successfully retrieved.", "schema": { "$ref": "#/definitions/RoomDocumentList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetDocuments", "x-ds-method": "GetDocuments", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/documents/contents": { "post": { "tags": [ "Rooms" ], "summary": "Uploads the contents of a file as a document to a room.", "description": "This method uploads the contents of file as a room document for the room that you specify.\n\nThis is a multipart form request. You must include the following headers:\n\n- `Content-Type: multipart/form-data` (with a `boundary`)\n- `Content-Disposition: form-data`\n- `Content-Disposition: file` (with the `filename`)\n\n\n### Related topics\n\n- [How to attach documents via binary transfer (eSignature)](/docs/esign-rest-api/how-to/send-binary/)\n An eSignature API example that illustrates how to build a multi-part JSON request.\n- Multipart form requests in [Formatting API requests](/docs/esign-rest-api/esign101/rules-and-limits/requests/)\n\n", "operationId": "Rooms_AddDocumentToRoomViaFileUpload", "consumes": [ "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "formData", "name": "file", "description": "File to be uploaded", "type": "file" } ], "responses": { "201": { "description": "Document successfully added.", "schema": { "$ref": "#/definitions/RoomDocument" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "AddDocumentToRoomViaFileUpload", "x-ds-method": "AddDocumentToRoomViaFileUpload", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/picture": { "put": { "tags": [ "Rooms" ], "summary": "Updates the picture for a room.", "description": "Updates the photo for a room.\nThe image file size limit is approximately 40 MB,\nand you can use the following image formats:\n\n- jpg/jpeg\n- png\n- tiff\n- gif\n\n\nIn the request body of this endpoint,\nyou can specify the image as:\n\n- a JSON object\n- multipart form data\n- stream data\n\nTo upload an image as a JSON object,\nuse an object with two string properties:\n- `fileName`: the name of the file\n- `base64Contents`: the base64 representation of the image.\nFor example a cURL request might look like this:\n\n```bash\ncurl --request PUT '/restapi/v2/accounts/{accountId}/rooms/{roomId}/picture' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"fileName\":\"name-of-file.jpg\",\n \"base64Contents\":\"iVBOR...RK3IAK5CYII=\"\n }'\n```\n\nUsing multipart form data removes the need to encode images in base64 format.\nSee _Multipart form requests_ in [Formatting API requests](/docs/esign-rest-api/esign101/rules-and-limits/requests/)\nfor details and an example.\n\nTo use other other streamed binary content types,\nuse the `Content-Disposition` request header.\n\n```\nContent-Disposition: file; filename=\"hello.jpg\"\n```\n", "operationId": "Rooms_UpdatePicture", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "formData", "description": "File to be uploaded", "name": "file", "type": "file" } ], "responses": { "200": { "description": "Picture successfully updated.", "schema": { "$ref": "#/definitions/RoomPicture" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "UpdatePicture", "x-ds-method": "UpdatePicture", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/field_set": { "get": { "tags": [ "Rooms" ], "summary": "Gets the field set for a room.", "description": "Returns the field set that a room uses. This is the set of fields that appears on the room's **Details** tab in the console, such as `contactName` and `phone`.\n\nYou can use this method to gain a better understanding of the room field data retrieved with\nthe [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/) method, and to determine the fields for which you can provide data when you create a new room.\n\n## Permissions\n\nAnyone in the room can call this method.", "operationId": "Rooms_GetRoomFieldSet", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "FieldSet successfully retrieved.", "schema": { "$ref": "#/definitions/FieldSet" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoomFieldSet", "x-ds-method": "GetRoomFieldSet", "x-ds-service": "Rooms", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/rooms/{roomId}/task_lists": { "get": { "tags": [ "TaskLists" ], "summary": "Gets task lists for a room.", "description": "Returns the task lists associated with a room.\n\n## Permissions\n\nYou must either be a member of the room who has been added to one or more tasks, or have one of the following permissions set to **true:** \n\n- `canAddTasksToAnyTaskLists`\n- `canApplyTaskList`\n- `canRemoveAnyTaskList`\n- `canSubmitTaskList`\n- `canReviewTaskList`\n\n**Note:** If a room has multiple tasks lists, you only see the task lists that contain tasks to which you have been added.", "operationId": "TaskLists_GetTaskLists", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Task lists successfully retrieved.", "schema": { "$ref": "#/definitions/TaskListSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTaskLists", "x-ds-method": "GetTaskLists", "x-ds-service": "TaskLists", "x-ds-in-sdk": true }, "post": { "tags": [ "TaskLists" ], "summary": "Applies a task list to a room.", "description": "Applies a task list to a room, based on the `taskTemplateId` that you specify in the `taskList` request body.\n\n**Note:** You must first create a task list template in the console. You cannot create a task list template by using the API at this time. To get the `taskListTemplateId`, use the \tTaskListTemplates: GetTaskListTemplates method.\n\n## Permissions\n\nYou must have the `canApplyTaskList` permission set to **true.**", "operationId": "TaskLists_CreateTaskList", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "roomId", "description": "The ID of the room.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/TaskListForCreate" } } ], "responses": { "201": { "description": "Task lists successfully created.", "schema": { "$ref": "#/definitions/TaskList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "CreateTaskList", "x-ds-method": "CreateTaskList", "x-ds-service": "TaskLists", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/room_templates": { "get": { "tags": [ "RoomTemplates" ], "summary": "Gets room templates.", "description": "This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates.\n\n", "operationId": "RoomTemplates_GetRoomTemplates", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "officeId", "description": "The ID of the office for which the user wants to create a room. When you pass in a value for this parameter, only room templates that are valid for that office appear in the results. For users who are not Admins, the default is the ID of the user's default office.\nHowever, you can specify a value if the user belongs to multiple offices.\n\nIf the user is an Admin, set the `forAdmin` search parameter to **true** instead and omit the `officeId` parameter. ", "type": "integer", "format": "int32" }, { "in": "query", "name": "onlyAssignable", "description": "When **true,** returns only the roles that the current user can assign to someone else. The default value is **false.**", "type": "boolean", "default": false }, { "in": "query", "name": "onlyEnabled", "description": "When true, only returns room templates that are not disabled.", "type": "boolean", "default": true }, { "in": "query", "name": "count", "description": "The number of results. When this property is used as a request parameter specifying the number of results to return, the value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "query", "name": "startPosition", "description": "The index position within the total result set from which to start returning values. The default value is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully retrieved room templates for the caller", "schema": { "$ref": "#/definitions/RoomTemplatesSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetRoomTemplates", "x-ds-method": "GetRoomTemplates", "x-ds-service": "RoomTemplates", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/task_lists/{taskListId}": { "delete": { "tags": [ "TaskLists" ], "summary": "Deletes a task list from a room.", "description": "Deletes the specified task list from a room. If there are attached documents, they will remain in the associated room.\n\n## Permissions\n\nYou must have the `canRemoveAnyTaskList` permission set to **true.**", "operationId": "TaskLists_DeleteTaskList", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "taskListId", "description": "The ID of the task list.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Task list successfully deleted." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "DeleteTaskList", "x-ds-method": "DeleteTaskList", "x-ds-service": "TaskLists", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/task_list_templates": { "get": { "tags": [ "TaskListTemplates" ], "summary": "Gets task list templates.", "description": "Returns all task list templates associated with the active user's company.\n\n## Permissions\n\nAnyone with a valid access token can call this method.\n\n", "operationId": "TaskListTemplates_GetTaskListTemplates", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "startPosition", "description": "The starting zero-based index position from which to start returning values. The default is `0`.", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "count", "description": "The number of results to return. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successfully returned list of task list templates.", "schema": { "$ref": "#/definitions/TaskListTemplateList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetTaskListTemplates", "x-ds-method": "GetTaskListTemplates", "x-ds-service": "TaskListTemplates", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users": { "get": { "tags": [ "Users" ], "summary": "Gets a list of users.", "description": "Returns a list of users associated with an account based on the criteria that you specify.", "operationId": "Users_GetUsers", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "query", "name": "filter", "description": "Filters results by name and email address. This is a \"starts with\" filter, which means that you can enter only the beginning of a name or email address. \n\n**Note:** You do not use a wildcard with this filter.", "type": "string" }, { "in": "query", "name": "sort", "description": "Specifies how to sort the results. Valid values are:\n\n- `FirstNameAsc`\n- `LastNameAsc`\n- `EmailAsc`\n- `FirstNameDesc`\n- `LastNameDesc`\n- `EmailDesc`" }, { "in": "query", "name": "defaultOfficeId", "description": "Filters for users who have this office ID as their default office ID.", "type": "integer", "format": "int32" }, { "in": "query", "name": "accessLevel", "description": "Filters for users who have the specified access level. A user's access level and role determine the types of resources and actions that are available to them.\n\nValid values are:\n- Company: Users with this access level can administer resources across the company.\n- Region: Users with this access level can administer offices and other resources within their regions. \n- Office: Users with this access level can administer resources within their offices.\n- Contributor: Users with this access level can only administer their own resources.\n\n**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." }, { "in": "query", "name": "titleId", "description": "This field is deprecated in Rooms Version 6.", "type": "integer", "format": "int32" }, { "in": "query", "name": "roleId", "description": "Filters for users who have the specified `roleId`.", "type": "integer", "format": "int32" }, { "in": "query", "name": "status", "description": "Filters for users who have the specified `status`.\n\nValid values are:\n\n- `Active`: The user is active.\n- `Pending`: The user has been invited but has not yet accepted the invitation." }, { "in": "query", "name": "lockedOnly", "description": "When **true,** filters for users whose accounts are locked.", "type": "boolean" }, { "in": "query", "name": "startPosition", "description": "The starting zero-based index position within the result set from which to begin the response. The default is `0`. ", "type": "integer", "format": "int32", "default": 0 }, { "in": "query", "name": "count", "description": "The maximum number of users to return in the response. This value must be a number between `1` and `100` (default).", "type": "integer", "format": "int32", "default": 100 }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Users information successfully retrieved.", "schema": { "$ref": "#/definitions/UserSummaryList" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetUsers", "x-ds-method": "GetUsers", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "Gets a user.", "description": "Returns details about the specified user.", "operationId": "Users_GetUser", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "User information successfully retrieved.", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "GetUser", "x-ds-method": "GetUser", "x-ds-service": "Users", "x-ds-in-sdk": true }, "put": { "tags": [ "Users" ], "summary": "Updates a user's default office.", "description": "Changes a user's default office. This is the office to which the user belongs by default.\n\n## Permissions\n\nYou must have at least one of the following permissions set to **true,** depending on the level of the user that you want to update:\n\n- `canManageMemberLowerAccessLevel`: Users can modify other users who have a lower access level than their own (in offices or regions that they oversee).\n- `canManageMemberSameAccessLevel`: Users can modify other users who have the same access level as their own (in offices or regions that they oversee or belong to).", "operationId": "Users_UpdateUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to update.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/UserForUpdate" } } ], "responses": { "200": { "description": "User information successfully updated.", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "UpdateUser", "x-ds-method": "UpdateUser", "x-ds-service": "Users", "x-ds-in-sdk": true }, "delete": { "tags": [ "Users" ], "summary": "Removes a user from a company account.", "description": "Removes the specified user from the specified account.\n\n## Permissions\n\nTo remove a user who has a lower access level, you must have the `canRemoveCompanyMemberLowerAccessLevel` permission set to **true.** \n\nTo remove a user who has the same access level, you must have the `canRemoveCompanyMemberSameAccessLevel` permission set to **true.** ", "operationId": "Users_RemoveUser", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to remove.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "The User was successfully removed." }, "400": { "description": "The User could not be removed.", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RemoveUser", "x-ds-method": "RemoveUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/invite_user": { "post": { "tags": [ "Users" ], "summary": "Invites a user to a company account.", "description": "Invites a new user to join a company account. You specify the custom role and access level that you want to give to the user in the `invitee` request body.\n\n## Permissions\n\nTo invite users to a company, you must be either a Default Admin or another authorized user who has access to all of the locations to which the new user is being invited and one of the following `userPermissions` set to **true:**\n\n- `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).\n- `canAddMemberAndSetRoleSameAccessLevel`: Users can add other users who have the same access level as their own or lower and set those users' roles (in offices or regions that they oversee or belong to).\n\n**Important:** DocuSign strongly recommends that you set up custom roles for your company before inviting users. If you do not, all new users will be added as administrators. For more information, see [Roles][Roles].\n\n[Roles]: /docs/rooms-api/reference/Roles/Roles/", "operationId": "Users_InviteUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/UserToInvite" } } ], "responses": { "201": { "description": "User successfully invited.", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "InviteUser", "x-ds-method": "InviteUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/reinvite": { "post": { "tags": [ "Users" ], "summary": "Reinvites a user to join a company account.", "description": "Reinvites an unactivated user to join a company account.\n\nInvitations expire after 30 days and can no longer be accepted. Use this method to send a new copy of an invitation to a pending user.", "operationId": "Users_ReinviteUser", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to reinvite.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "User successfully reinvited." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "ReinviteUser", "x-ds-method": "ReinviteUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/add_to_office": { "post": { "tags": [ "Users" ], "summary": "Adds a user to an office.", "description": "Adds an existing user to a single office. You specify the office to which you want to add the user in the `designatedOffice` request body.\n\nTo add a user to multiple offices, you must make this call separately for each office.\n\n**Note:** The `accessLevel` of the user that you are adding must be `contributor` or `office`.\n\n## Permissions\n\nYou must have at least one of the following permissions set to **true,** depending on the level of the user that you want to add or remove:\n\n- `canManageMemberLowerAccessLevel`: Users can add and remove other users who have a lower access level than their own (in offices or regions that they oversee) from a region or office. They can also modify those users.\n- `canManageMemberSameAccessLevel`: Users can add and remove other users who have the same access level as their own (in offices or regions that they oversee or belong to) from a region or office. They can also modify those users.", "operationId": "Users_AddUserToOffice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to add.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DesignatedOffice" } } ], "responses": { "204": { "description": "User successfully added to the office." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "AddUserToOffice", "x-ds-method": "AddUserToOffice", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/remove_from_office": { "post": { "tags": [ "Users" ], "summary": "Removes a user from an office.", "description": "Removes a user from a single office. You specify the office from which you want to remove the user in the `designatedOffice` request body.\n\nThe user still maintains their other office, region, company, and account associations.\n\n**Note:** You cannot remove a user from their default office. You must first assign the user a different default office by using the [Users: updateUser][updateUser] method.\n\n[updateUser]: /docs/rooms-api/reference/Users/Users/UpdateUser/\n\n## Permissions\n\nYou must have at least one of the following permissions set to **true,** depending on the level of the user that you want to add or remove:\n\n- `canManageMemberLowerAccessLevel`: Users can add or remove other users who have a lower access level than their own (in offices or regions that they oversee) from a region or office.\n- `canManageMemberSameAccessLevel`: Users can modify other users who have the same access level as their own (in offices or regions that they oversee or belong to) from a region or office.", "operationId": "Users_RemoveUserFromOffice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to remove.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DesignatedOffice" } } ], "responses": { "204": { "description": "User successfully removed from the office." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RemoveUserFromOffice", "x-ds-method": "RemoveUserFromOffice", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/add_to_region": { "post": { "tags": [ "Users" ], "summary": "Adds a user to a region.", "description": "Adds an existing user to a region. You specify the region to which you want to add the user in the `designatedRegion` request body.\n\nTo add a user to multiple regions, you must make this call separately for each region.\n\n**Note:** The `accessLevel` of the user that you are adding must be `region`.\n\n## Permissions\n\nYou must have at least one of the following permissions set to **true,** depending on the level of the user that you want to add or remove:\n\n- `canManageMemberLowerAccessLevel`: Users can add or remove other users who have a lower access level than their own (in offices or regions that they oversee).\n- `canManageMemberSameAccessLevel`: Users can modify other users who have the same access level as their own (in offices or regions that they oversee or belong to).", "operationId": "Users_AddUserToRegion", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to add.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DesignatedRegion" } } ], "responses": { "204": { "description": "User successfully added to the region." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "AddUserToRegion", "x-ds-method": "AddUserToRegion", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/remove_from_region": { "post": { "tags": [ "Users" ], "summary": "Removes a user from a region.", "description": "Removes a user from a single region. You specify the region from which you want to remove the user in the `designatedRegion` request body.\n\nThe user still maintains their other region, company, and account associations.\n\n## Permissions\n\nYou must have at least one of the following permissions set to **true,** depending on the level of the user that you want to add or remove:\n\n- `canManageMemberLowerAccessLevel`: Users can add or remove other users who have a lower access level than their own (in offices or regions that they oversee) from a region or office.\n- `canManageMemberSameAccessLevel`: Users can modify other users who have the same access level as their own (in offices or regions that they oversee or belong to) from a region or office.\n\n**Note:** You cannot remove a user from the region that contains their default office. You must first change the user's default office by using the Users: UpdateUser method.", "operationId": "Users_RemoveUserFromRegion", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json", "application/xml", "text/xml", "application/*+xml" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to remove.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DesignatedRegion" } } ], "responses": { "204": { "description": "User successfully removed from the region." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "RemoveUserFromRegion", "x-ds-method": "RemoveUserFromRegion", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/lock": { "post": { "tags": [ "Users" ], "summary": "Locks a user's account.", "description": "Locks the account of the specified user. Use the `reason` property in the request body to specify why the account was locked.\n\n## Permissions\n\nTo lock a user who has a lower access level than you, you must have the `canManageMemberLowerAccessLevel` permission set to **true.**\nTo lock a user who has the same access level as you, you must have the `canManageMemberSameAccessLevel` permission set to **true** \n", "operationId": "Users_LockUser", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "ID of the user to lock.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/LockedOutDetails" } } ], "responses": { "204": { "description": "User has been successfully locked out." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "LockUser", "x-ds-method": "LockUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/accounts/{accountId}/users/{userId}/unlock": { "post": { "tags": [ "Users" ], "summary": "Unlocks a user's account.", "description": "Unlocks the account of the specified user.\n\n## Permissions\n\n- To unlock a user who has a lower access level than you, you must have the `canManageMemberLowerAccessLevel` permission set to **true.**\n- To unlock a user who has the same access level as you, you must have the `canManageMemberSameAccessLevel` permission set to **true.**", "operationId": "Users_UnlockUser", "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "in": "path", "name": "userId", "description": "The ID of the user to unlock.", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "accountId", "description": "The globally unique identifier (GUID) for the account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "User has been successfully unlocked." }, "400": { "description": "Bad request. See ErrorCode and Message for details", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Not authorized to make this request.", "schema": { "$ref": "#/definitions/ApiError" } } }, "x-ds-methodname": "UnlockUser", "x-ds-method": "UnlockUser", "x-ds-service": "Users", "x-ds-in-sdk": true } } }, "definitions": { "AccessLevel": { "enum": [ "Contributor", "Office", "Region", "Company", "Admin" ], "type": "string", "x-ds-definition-name": "AccessLevel", "description": "", "x-ms-summary": "" }, "AccountStatus": { "enum": [ "Active", "Pending" ], "type": "string", "x-ds-definition-name": "AccountStatus", "description": "", "x-ms-summary": "" }, "AccountSummary": { "type": "object", "properties": { "companyId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the company." }, "name": { "type": "string", "readOnly": true, "description": "The name of the company." }, "companyVersion": { "enum": [ "v5", "v6" ], "type": "string", "description": "The version of Rooms that the company uses. This property is read-only. Possible values are:\n\n- `v6`: Rooms Version 6." }, "docuSignAccountGuid": { "type": "string", "readOnly": true, "description": "The globally-unique identifier (GUID) for the DocuSign Rooms account." }, "defaultFieldSetId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the company's default field set. A field set is a set of data fields and the information about those data fields that the system uses to configure rooms. It corresponds to the **Admin > Company > Room Details** area in the console." }, "requireOfficeLibraryAssignments": { "type": "boolean", "readOnly": true, "description": "" } }, "x-ds-definition-name": "AccountSummary", "description": "Contains details about a company account.", "x-ms-summary": "Contains details about a company account." }, "ActivityType": { "type": "object", "properties": { "activityTypeId": { "type": "string", "description": "The ID of the activity type.\n\nExample: `movefrominbx`" }, "name": { "type": "string", "description": "The name of the activity type.\n\nExample: `Document Moved from Inbox`" } }, "x-ds-definition-name": "ActivityType", "description": "Details about an activity type.", "x-ms-summary": "Details about an activity type." }, "ApiError": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The code associated with the error condition." }, "message": { "type": "string", "description": "A brief message describing the error condition." }, "referenceId": { "type": "string", "description": "" } }, "x-ds-definition-name": "ApiError", "description": "This object describes errors that occur. It is valid only for responses and ignored in requests.", "x-ms-summary": "This object describes errors that occur. It is valid only for responses and ignored in requests." }, "AssignableRoles": { "type": "object", "properties": { "currentRoleId": { "format": "int32", "type": "integer", "description": "The ID of the invitee's company-level role. This property lets the requester know what room-level role will give the user the same permissions that they have at the company level. A value is returned only when both the requester and the invitee are internal to the company." }, "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleSummary" }, "description": "An array of `role` objects." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "AssignableRoles", "description": "This complex type contains information about assignable roles.", "x-ms-summary": "This complex type contains information about assignable roles." }, "ClassicManagerPermissions": { "type": "object", "properties": { "isVisibleInTransactionRooms": { "type": "boolean", "description": "When **true,** the user is visible in company rooms.\n\n**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." }, "canDeleteCompanyRooms": { "type": "boolean", "description": "When **true,** the user can delete company rooms." }, "canDeleteCompanyDocuments": { "type": "boolean", "description": "When **true,** the user can delete company documents." }, "canManageCompanyRooms": { "type": "boolean", "description": "When **true,** the user can manage company rooms." }, "canManageCompanyAccount": { "type": "boolean", "description": "When **true,** the user can manage the company's account." }, "canManageCompanySharedLibrary": { "type": "boolean", "description": "When **true,** the user can manage the company's shared library." }, "canManageCompanyMembers": { "type": "boolean", "description": "When **true,** the user can manage other users on the company's account." }, "canCloseCompanyRooms": { "type": "boolean", "description": "When **true,** the user can close company rooms." }, "canApproveCompanyChecklists": { "type": "boolean", "description": "When **true,** the user can approve company checklists." }, "isCompanySystemAdmin": { "type": "boolean", "description": "When **true,** the user is a system administrator for the company." }, "isRegionManager": { "type": "boolean", "description": "When **true,** the user is a region manager." }, "isOfficeManager": { "type": "boolean", "description": "When **true,** the user is an office manager." }, "autoAccessToCompanyRooms": { "type": "boolean", "description": "When **true,** the user is automatically added to new company rooms and is visible in those rooms." } }, "x-ds-definition-name": "ClassicManagerPermissions", "description": "This object contains details about user permissions. These permissions are associated only with Rooms v5.", "x-ms-summary": "This object contains details about user permissions. These permissions are associated only with Rooms v5." }, "ClosingStatus": { "type": "object", "properties": { "closingStatusId": { "type": "string", "description": "The ID of the closing status.\n\nExample: `exp`" }, "name": { "type": "string", "description": "The name of the closing status.\n\nExample: `Listing Expired`" } }, "x-ds-definition-name": "ClosingStatus", "description": "Contains information about a closing status, or reason for closing a room.", "x-ms-summary": "Contains information about a closing status, or reason for closing a room." }, "ContactSide": { "type": "object", "properties": { "contactSideId": { "type": "string", "description": "The ID of the contact side.\n\nExample: `L`" }, "name": { "type": "string", "description": "The name of the contact side.\n\nExample: `Listing`" } }, "x-ds-definition-name": "ContactSide", "description": "Details about a contact side.", "x-ms-summary": "Details about a contact side." }, "Country": { "type": "object", "properties": { "countryId": { "type": "string", "description": "The two-letter code for the country. \n\nExample: `NZ`" }, "name": { "type": "string", "description": "The name of the country. \n\nExample: `New Zealand`" } }, "x-ds-definition-name": "Country", "description": "Contains details about a supported country.", "x-ms-summary": "Contains details about a supported country." }, "Currency": { "type": "object", "properties": { "currencyId": { "type": "string", "description": "The three-letter code for the currency.\n\nExample: `CAD`" }, "name": { "type": "string", "description": "The name of the currency.\n\nExample: `Canadian Dollar`" } }, "x-ds-definition-name": "Currency", "description": "Contains details about a supported currency.", "x-ms-summary": "Contains details about a supported currency." }, "CustomData": { "type": "object", "properties": { "isRequiredOnCreate": { "type": "boolean", "readOnly": true, "description": "When **true,** the field is required when a new room is created." }, "isRequiredOnSubmit": { "type": "boolean", "readOnly": true, "description": "When **true,** the field is required when a room is submitted for review." } }, "x-ds-definition-name": "CustomData", "description": "Contains information about whether the field is required when a room is created or submitted for review.", "x-ms-summary": "Contains information about whether the field is required when a room is created or submitted for review." }, "DependsOn": { "type": "object", "properties": { "actionType": { "type": "string", "readOnly": true, "description": "The child field action that depends on the parent field.\n\nExample: `visibility`\n\nFor example, in the console, you must select a country for a list of states to become visible." }, "parentApiName": { "type": "string", "readOnly": true, "description": "The name that the Rooms API uses for the parent field.\n\nExample: `country`" } }, "x-ds-definition-name": "DependsOn", "description": "Contains information about a parent field on which this field depends.", "x-ms-summary": "Contains information about a parent field on which this field depends." }, "DesignatedOffice": { "required": [ "officeId" ], "type": "object", "properties": { "officeId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the office. This is the ID that the system generated when you created the office." } }, "x-ds-definition-name": "DesignatedOffice", "description": "This object contains information about the office that you want to add a member to or remove a member from.", "x-ms-summary": "This object contains information about the office that you want to add a member to or remove a member from." }, "DesignatedRegion": { "required": [ "regionId" ], "type": "object", "properties": { "regionId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the region. This is the ID that the system generated when you created the region." } }, "x-ds-definition-name": "DesignatedRegion", "description": "This object contains information about the region associated with the member.", "x-ms-summary": "This object contains information about the region associated with the member." }, "Document": { "required": [ "base64Contents", "name" ], "type": "object", "properties": { "documentId": { "format": "int32", "type": "integer", "description": "The ID of the document." }, "name": { "type": "string", "description": "The file name associated with the document." }, "roomId": { "format": "int32", "type": "integer", "description": "The ID of the room associated with the document." }, "ownerId": { "format": "int32", "type": "integer", "description": "The ID of the user who owns the document." }, "size": { "format": "int64", "type": "integer", "description": "The size of the document in bytes." }, "folderId": { "format": "int32", "type": "integer", "description": "The ID of the folder that holds the document." }, "createdDate": { "format": "date-time", "type": "string", "description": "The date and time when the document was created. This is a read-only value that the service assigns.\n\nExample: `2019-11-11T17:15:14.82`" }, "isSigned": { "type": "boolean", "description": "When **true,** indicates that the document is signed." }, "contentType": { "type": "string", "description": "" }, "base64Contents": { "type": "string", "description": "The base64-encoded contents of the document. This property is only included in the response when you use the `includeContents` query parameter and set it to **true.**" }, "isDynamic": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "Document", "description": "Contains information about a document.", "x-ms-summary": "Contains information about a document." }, "DocumentUser": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "description": "The ID of the user." }, "documentId": { "format": "int32", "type": "integer", "description": "The ID of the document." }, "name": { "type": "string", "description": "The file name associated with the document." }, "hasAccess": { "type": "boolean", "description": "**True** if the user `userId` has access to this document." }, "canApproveTask": { "type": "boolean", "description": "**True** if the user `userId` has can approve a task for this document." }, "canAssignToTaskList": { "type": "boolean", "description": "**True** if the user `userId` can assign this document to a task list." }, "canCopy": { "type": "boolean", "description": "**True** if the user `userId` can make a copy of this document." }, "canDelete": { "type": "boolean", "description": "**True** if the user `userId` can delete this document." }, "canRemoveFromTaskList": { "type": "boolean", "description": "**True** if the user `userId` can remove this document from a task list." }, "canRemoveApproval": { "type": "boolean", "description": "**True** if the user `userId` can remove approval for this document." }, "canRename": { "type": "boolean", "description": "**True** if the user `userId` can rename this document." }, "canShare": { "type": "boolean", "description": "**True** if the user `userId` can share this document." }, "canViewActivity": { "type": "boolean", "description": "**True** if the user `userId` can view activity on this document." } }, "x-ds-definition-name": "DocumentUser", "description": "", "x-ms-summary": "" }, "DocumentUserForCreate": { "required": [ "userId" ], "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "description": "The ID of the user." } }, "x-ds-definition-name": "DocumentUserForCreate", "description": "", "x-ms-summary": "" }, "ESignAccountRoleSettings": { "type": "object", "properties": { "allowAccountManagement": { "type": "boolean", "description": "A Boolean specifying whether users with this eSignature permission profile can manage the Rooms account. This property is read-only and has the following values:\n\n- `DS Admin` permission profile: **true**\n- `DS Sender` permission profile: **false**\n- `DS Viewer` permission profile: **false**\n\n\n\n\n" } }, "x-ds-definition-name": "ESignAccountRoleSettings", "description": "This object contains details about the permissions associated with a eSignature permission profile.", "x-ms-summary": "This object contains details about the permissions associated with a eSignature permission profile." }, "ESignPermissionProfile": { "type": "object", "properties": { "eSignPermissionProfileId": { "type": "string", "description": "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." }, "name": { "type": "string", "description": "The name of the eSignature permission profile. Valid values are:" }, "settings": { "$ref": "#/definitions/ESignAccountRoleSettings", "description": "the eSignature account role settings associated with the permission profile." } }, "x-ds-definition-name": "ESignPermissionProfile", "description": "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. This object contains information about the eSignature permission profile, which controls member access to the eSignature account. ", "x-ms-summary": "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. This object contains information about the eSignature permission profile, which controls member access to the eSignature account. " }, "ESignPermissionProfileList": { "type": "object", "properties": { "permissionProfiles": { "type": "array", "items": { "$ref": "#/definitions/ESignPermissionProfile" }, "readOnly": true, "description": "An array of eSignature `permissionProfile` objects." } }, "x-ds-definition-name": "ESignPermissionProfileList", "description": "This object contains a list of eSignature permission profiles.", "x-ms-summary": "This object contains a list of eSignature permission profiles." }, "Envelope": { "type": "object", "properties": { "eSignEnvelopeId": { "type": "string", "description": "" } }, "x-ds-definition-name": "Envelope", "description": "", "x-ms-summary": "" }, "EnvelopeForCreate": { "type": "object", "properties": { "envelopeName": { "type": "string", "description": "" }, "documentIds": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "" } }, "x-ds-definition-name": "EnvelopeForCreate", "description": "", "x-ms-summary": "" }, "ExternalFormFillSession": { "type": "object", "properties": { "url": { "format": "uri", "type": "string", "description": "The URL for the new form fill session." } }, "x-ds-definition-name": "ExternalFormFillSession", "description": "Contains the URL for the new form fill session.", "x-ms-summary": "Contains the URL for the new form fill session." }, "ExternalFormFillSessionForCreate": { "required": [ "roomId" ], "type": "object", "properties": { "formId": { "type": "string", "description": "(Required) The ID of the form.\n\nExample: `5be324eb-xxxx-xxxx-xxxx-208065181be9`\n" }, "roomId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the room." }, "formIds": { "type": "array", "items": { "format": "uuid", "type": "string" }, "description": "" }, "xFrameAllowedUrl": { "type": "string", "description": "(Optional) This property specifies the origin on which the page is allowed to display in a frame." } }, "x-ds-definition-name": "ExternalFormFillSessionForCreate", "description": "Contains the details required to create a form fill session.", "x-ms-summary": "Contains the details required to create a form fill session." }, "Field": { "type": "object", "properties": { "fieldId": { "format": "uuid", "type": "string", "readOnly": true, "description": "An ID that uniquely identifies the instance of a `fieldDefinition` within a field set." }, "fieldDefinitionId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the DocuSign field definition from which this field derives. When an Admin user configures a field set by using the API, this is the ID that they use to add this field definition to the field set. The original field definition associated with this ID contains more information about the field, such as the default title, default API name, and configurations such as the maximum length or the maximum value allowed." }, "title": { "type": "string", "readOnly": true, "description": "The human-readable title or name of the field.\n\nExample: `Company contact name`" }, "apiName": { "type": "string", "readOnly": true, "description": "The name that the Rooms API uses for the field. \n\nExample: `companyContactName`\n\n**Note:** When you create a new room, you use the `apiName` values for fields to specify the details that you want to appear on the room's **Details** tab." }, "type": { "type": "string", "readOnly": true, "description": "The type of field. Valid values:\n\n- `Date`\n- `Text`\n- `Checkbox`\n- `Currency`\n- `Numeric`\n- `SelectList`\n- `TextArea`\n- `Percentage`\n- `Integer`\n\n" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/Field" }, "readOnly": true, "description": "An array of subfields." }, "configuration": { "$ref": "#/definitions/FieldConfiguration", "description": "Contains information about how the field is configured, such as the maximum length." }, "customData": { "$ref": "#/definitions/CustomData", "description": "Contains information about whether the field is required when a room is created or submitted for review." } }, "x-ds-definition-name": "Field", "description": "Contains details about a field in a field set.", "x-ms-summary": "Contains details about a field in a field set." }, "FieldConfiguration": { "type": "object", "properties": { "maxValue": { "format": "double", "type": "number", "readOnly": true, "description": "The maximum value allowed for the field." }, "minValue": { "format": "double", "type": "number", "readOnly": true, "description": "The minimum value allowed for the field." }, "multipleOf": { "format": "double", "type": "number", "readOnly": true, "description": "This property is used for validation. When you set a number value for this property, the value for the field must be a multiple of it." }, "maxLength": { "format": "int32", "type": "integer", "readOnly": true, "description": "The maximum length of the field." }, "minLength": { "format": "int32", "type": "integer", "readOnly": true, "description": "The minimum length of the field." }, "pattern": { "type": "string", "readOnly": true, "description": "The regular expression pattern to use to validate the value of the field." }, "isPublisher": { "type": "boolean", "readOnly": true, "description": "When **true,** the field is a parent field on which one or more child fields depend." }, "dependsOn": { "type": "array", "items": { "$ref": "#/definitions/DependsOn" }, "readOnly": true, "description": "This property applies to child fields. It contains information about the parent field that must have a value set in order for this field to have a value. For example, you must specify a country before you can select a state." }, "options": { "type": "array", "items": { "$ref": "#/definitions/SelectListFieldOption" }, "readOnly": true, "description": "An array of options in a list." } }, "x-ds-definition-name": "FieldConfiguration", "description": "Contains details about how a field is configured.", "x-ms-summary": "Contains details about how a field is configured." }, "FieldData": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {}, "description": "Field data is a collection of name/value pairs where the names correspond to the fields in the room's **Details** tab. The value of a name/value pair can be a field data collection itself. These collections are implemented as JSON objects.\n\nThe fields `address1`, `state`, `postalCode`, and `city` are required. The `state` value must be a `stateId` value returned by the [getStates](/docs/rooms-api/reference/globalresources/states/getstates/) endpoint. For example, use \"US-WA\" instead of \"Washington\".\n\nFor example, the data for fields named \"Tax annual amount\" and \"buyer1\" (along with the required fields) might look like this: \n\n```\n{\n \"data\": {\n \"taxAnnualAmount\": 3389.12,\n \"buyer1\": {\n \"name\": \"Elle Woods\",\n \"homePhone\": \"123-456-7890\",\n \"state\": \"US-CA\",\n \"email\": \"elle.woods@harvard.edu\"\n },\n \"address1\": \"123 Harvard Street\",\n \"state\": \"US-MA\",\n \"postalCode\": \"02138\",\n \"city\": \"Cambridge\"\n }\n}\n```\n" } }, "x-ds-definition-name": "FieldData", "description": "The field data associated with a room.\nSee [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/).", "x-ms-summary": "The field data associated with a room.\nSee [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/)." }, "FieldDataForCreate": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {}, "description": "Field data is a collection of name/value pairs where the names correspond to the fields in the room's **Details** tab. The value of a name/value pair can be a field data collection itself. These collections are implemented as JSON objects.\n\nThe fields `address1`, `state`, `postalCode`, and `city` are required. The `state` value must be a `stateId` value returned by the [getStates](/docs/rooms-api/reference/globalresources/states/getstates/) endpoint. For example, use \"US-WA\" instead of \"Washington\".\n\nFor example, the data for fields named \"Tax annual amount\" and \"buyer1\" (along with the required fields) might look like this: \n\n```\n{\n \"data\": {\n \"taxAnnualAmount\": 3389.12,\n \"buyer1\": {\n \"name\": \"Elle Woods\",\n \"homePhone\": \"123-456-7890\",\n \"state\": \"US-CA\",\n \"email\": \"elle.woods@harvard.edu\"\n },\n \"address1\": \"123 Harvard Street\",\n \"state\": \"US-MA\",\n \"postalCode\": \"02138\",\n \"city\": \"Cambridge\"\n }\n}\n```\n" } }, "x-ds-definition-name": "FieldDataForCreate", "description": "Contains key-value pairs that specify the properties of the room and their values.", "x-ms-summary": "Contains key-value pairs that specify the properties of the room and their values." }, "FieldDataForUpdate": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {}, "description": "Field data is a collection of name/value pairs where the names correspond to the fields in the room's **Details** tab. The value of a name/value pair can be a field data collection itself. These collections are implemented as JSON objects.\n\nThe fields `address1`, `state`, `postalCode`, and `city` are required. The `state` value must be a `stateId` value returned by the [getStates](/docs/rooms-api/reference/globalresources/states/getstates/) endpoint. For example, use \"US-WA\" instead of \"Washington\".\n\nFor example, the data for fields named \"Tax annual amount\" and \"buyer1\" (along with the required fields) might look like this: \n\n```\n{\n \"data\": {\n \"taxAnnualAmount\": 3389.12,\n \"buyer1\": {\n \"name\": \"Elle Woods\",\n \"homePhone\": \"123-456-7890\",\n \"state\": \"US-CA\",\n \"email\": \"elle.woods@harvard.edu\"\n },\n \"address1\": \"123 Harvard Street\",\n \"state\": \"US-MA\",\n \"postalCode\": \"02138\",\n \"city\": \"Cambridge\"\n }\n}\n```\n" } }, "x-ds-definition-name": "FieldDataForUpdate", "description": "The field data to update. When updating field data, specify only the fields being updated.", "x-ms-summary": "The field data to update. When updating field data, specify only the fields being updated." }, "FieldSet": { "type": "object", "properties": { "fieldSetId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the field set.\n\nExample: `4aef602b-xxxx-xxxx-xxxx-08d76696f678`\n" }, "title": { "type": "string", "readOnly": true, "description": "The title or name of the field set." }, "fields": { "type": "array", "items": { "$ref": "#/definitions/Field" }, "readOnly": true, "description": "An array of fields." } }, "x-ds-definition-name": "FieldSet", "description": "Contains details about a field set.", "x-ms-summary": "Contains details about a field set." }, "FieldsCustomDataFilterType": { "enum": [ "None", "IsRequiredOnCreate", "IsRequiredOnSubmit" ], "type": "string", "x-ds-definition-name": "FieldsCustomDataFilterType", "description": "", "x-ms-summary": "" }, "FinancingType": { "type": "object", "properties": { "financingTypeId": { "type": "string", "description": "The ID of the financing type.\n\nExample: `conv` (for `Conventional`)" }, "name": { "type": "string", "description": "The name of the financing type. Possible values are:\n\n- `Cash`\n- `Conventional`\n- `FHA`\n- `VA`\n- `USDA`\n- `Bitcoin`\n- `Other`" } }, "x-ds-definition-name": "FinancingType", "description": "Contains information about a financing type.", "x-ms-summary": "Contains information about a financing type." }, "FormDetails": { "type": "object", "properties": { "formId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the form.\n\nExample: `5be324eb-xxxx-xxxx-xxxx-208065181be9`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the form.\n\nExample: `MORe Private Network Addendum`" }, "createdDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" }, "lastUpdatedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC date and time when the item was last updated. This is a read-only value that the service assigns.\n\nExample: 2019-07-17T17:45:42.783Z" }, "availableOnDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC DateTime when the form was made available or published. (It is possible for a form to be published but not yet available.)" }, "ownerName": { "type": "string", "readOnly": true, "description": "The name of the organization that owns the form.\n\nExample: `Mainstreet organization of Realtors`" }, "version": { "type": "string", "readOnly": true, "description": "The version of the form. \n\nExample: `1`" }, "numberOfPages": { "format": "int32", "type": "integer", "readOnly": true, "description": "The number of pages in the form.\n\nExample: `2`" } }, "x-ds-definition-name": "FormDetails", "description": "This resource contains details about a form, such as the date it was created and last updated, the number of pages, the form owner, and other information.", "x-ds-category": "Forms", "x-ds-order": "10", "x-ms-summary": "This resource contains details about a form, such as the date it was created and last updated, the number of pages, the form owner, and other information." }, "FormForAdd": { "required": [ "formId" ], "type": "object", "properties": { "formId": { "format": "uuid", "type": "string", "description": "(Required) The ID of the form." } }, "x-ds-definition-name": "FormForAdd", "description": "Contains details about the form that you want to add.", "x-ms-summary": "Contains details about the form that you want to add." }, "FormGroup": { "type": "object", "properties": { "formGroupId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "officeIds": { "uniqueItems": true, "type": "array", "items": { "format": "int32", "type": "integer" }, "readOnly": true, "description": "An array of office IDs." }, "forms": { "type": "array", "items": { "$ref": "#/definitions/GroupForm" }, "readOnly": true, "description": "A list of forms." } }, "x-ds-definition-name": "FormGroup", "description": "Result from getting a form group.", "x-ms-summary": "Result from getting a form group." }, "FormGroupForCreate": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group." } }, "x-ds-definition-name": "FormGroupForCreate", "description": "Request object for FormGroup: CreateFormGroup.", "x-ms-summary": "Request object for FormGroup: CreateFormGroup." }, "FormGroupForUpdate": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "FormGroupForUpdate", "description": "", "x-ms-summary": "" }, "FormGroupForm": { "type": "object", "properties": { "formId": { "format": "uuid", "type": "string", "description": "The ID of the form.\n\nExample: `5be324eb-xxxx-xxxx-xxxx-208065181be9`\n" }, "name": { "type": "string", "description": "The name of the office." }, "isRequired": { "type": "boolean", "description": "**True** if the form is required." }, "lastUpdatedDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was last updated. This is a read-only value that the service assigns.\n\nExample: 2019-07-17T17:45:42.783Z" } }, "x-ds-definition-name": "FormGroupForm", "description": "", "x-ms-summary": "" }, "FormGroupFormList": { "type": "object", "properties": { "forms": { "type": "array", "items": { "$ref": "#/definitions/FormGroupForm" }, "description": "A list of forms." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "FormGroupFormList", "description": "", "x-ms-summary": "" }, "FormGroupFormToAssign": { "required": [ "formId" ], "type": "object", "properties": { "formId": { "format": "uuid", "type": "string", "description": "The ID of the form.\n\nExample: `5be324eb-xxxx-xxxx-xxxx-208065181be9`\n" }, "isRequired": { "type": "boolean", "description": "**True** if the form is required." } }, "x-ds-definition-name": "FormGroupFormToAssign", "description": "", "x-ms-summary": "" }, "FormGroupSummary": { "type": "object", "properties": { "formGroupId": { "type": "string", "readOnly": true, "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the form group. \n\nExample: `Apartment Rental`" }, "formCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The number of forms in the form group.\n\nExample: `10`" } }, "x-ds-definition-name": "FormGroupSummary", "description": "Contains details about a form group.", "x-ms-summary": "Contains details about a form group." }, "FormGroupSummaryList": { "type": "object", "properties": { "formGroups": { "type": "array", "items": { "$ref": "#/definitions/FormGroupSummary" }, "description": "A list of form groups." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "FormGroupSummaryList", "description": "Contains a list of form groups.", "x-ms-summary": "Contains a list of form groups." }, "FormLibrarySummary": { "type": "object", "properties": { "formsLibraryId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the form library.\n\nExample: `402c6e2f-xxxx-xxxx-xxxx-ff3f249f6da9`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the form library.\n\nExample: `MOR - Mainstreet Organization of Realtors`" }, "formCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The number of forms in the form library. \n\nExample: `50`" } }, "x-ds-definition-name": "FormLibrarySummary", "description": "Contains details about a specific form library.", "x-ms-summary": "Contains details about a specific form library." }, "FormLibrarySummaryList": { "type": "object", "properties": { "formsLibrarySummaries": { "type": "array", "items": { "$ref": "#/definitions/FormLibrarySummary" }, "description": "A list of form libraries." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "FormLibrarySummaryList", "description": "Contains a list of forms libraries.", "x-ms-summary": "Contains a list of forms libraries." }, "FormProviderAssociationSummary": { "type": "object", "properties": { "associationId": { "type": "string", "readOnly": true, "description": "" }, "providerId": { "type": "string", "readOnly": true, "description": "The provider ID.\n\n" }, "lastUpdateDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "" }, "formProviderAssociationGuid": { "format": "uuid", "type": "string", "readOnly": true, "description": "" }, "formProviderAssociationName": { "type": "string", "readOnly": true, "description": "" } }, "x-ds-definition-name": "FormProviderAssociationSummary", "description": "", "x-ms-summary": "" }, "FormProviderAssociationsSummaryList": { "type": "object", "properties": { "formProviderAssociations": { "type": "array", "items": { "$ref": "#/definitions/FormProviderAssociationSummary" }, "description": "" }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "FormProviderAssociationsSummaryList", "description": "", "x-ms-summary": "" }, "FormSummary": { "type": "object", "properties": { "libraryFormId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the form.\n\nExample: `301f560d-xxxx-xxxx-xxxx-063a47cc12c2`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the form. \n\nExample: `Short Sale Supplement to Marketing Agreement`" }, "lastUpdatedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The date and time when the form was last updated.\n\nExample: `2017-08-11T19:58:36.18`" }, "viewingUserHasAccess": { "type": "boolean", "readOnly": true, "description": "" } }, "x-ds-definition-name": "FormSummary", "description": "Contains details about a form in a form library.", "x-ms-summary": "Contains details about a form in a form library." }, "FormSummaryList": { "type": "object", "properties": { "forms": { "type": "array", "items": { "$ref": "#/definitions/FormSummary" }, "description": "A list of forms." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "FormSummaryList", "description": "Contains a list of forms in a form library.", "x-ms-summary": "Contains a list of forms in a form library." }, "GlobalActivityTypes": { "type": "object", "properties": { "activityTypes": { "type": "array", "items": { "$ref": "#/definitions/ActivityType" }, "description": "A list of activity types." } }, "x-ds-definition-name": "GlobalActivityTypes", "description": "Contains a list of activity types.", "x-ms-summary": "Contains a list of activity types." }, "GlobalClosingStatuses": { "type": "object", "properties": { "closingStatuses": { "type": "array", "items": { "$ref": "#/definitions/ClosingStatus" }, "description": "A list of closing statuses (reasons for closing a room)." } }, "x-ds-definition-name": "GlobalClosingStatuses", "description": "Contains a list of valid closing statuses, or reasons for closing a room.", "x-ms-summary": "Contains a list of valid closing statuses, or reasons for closing a room." }, "GlobalContactSides": { "type": "object", "properties": { "contactSides": { "type": "array", "items": { "$ref": "#/definitions/ContactSide" }, "description": "A list of contact sides." } }, "x-ds-definition-name": "GlobalContactSides", "description": "Contains a list of contact sides.", "x-ms-summary": "Contains a list of contact sides." }, "GlobalCountries": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/definitions/Country" }, "description": "An array of country objects." } }, "x-ds-definition-name": "GlobalCountries", "description": "Contains a list of supported countries.", "x-ms-summary": "Contains a list of supported countries." }, "GlobalCurrencies": { "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/definitions/Currency" }, "description": "A list of currency objects." } }, "x-ds-definition-name": "GlobalCurrencies", "description": "Contains a list of supported currencies.", "x-ms-summary": "Contains a list of supported currencies." }, "GlobalFinancingTypes": { "type": "object", "properties": { "financingTypes": { "type": "array", "items": { "$ref": "#/definitions/FinancingType" }, "description": "A list of financing types." } }, "x-ds-definition-name": "GlobalFinancingTypes", "description": "Contains a list of financing types.", "x-ms-summary": "Contains a list of financing types." }, "GlobalOriginsOfLeads": { "type": "object", "properties": { "originsOfLeads": { "type": "array", "items": { "$ref": "#/definitions/OriginOfLead" }, "description": "A list of origins of leads." } }, "x-ds-definition-name": "GlobalOriginsOfLeads", "description": "Contains a list of origins of leads.", "x-ms-summary": "Contains a list of origins of leads." }, "GlobalPropertyTypes": { "type": "object", "properties": { "propertyTypes": { "type": "array", "items": { "$ref": "#/definitions/PropertyType" }, "description": "A list of property types." } }, "x-ds-definition-name": "GlobalPropertyTypes", "description": "Contains a list of property types.", "x-ms-summary": "Contains a list of property types." }, "GlobalRoomContactTypes": { "type": "object", "properties": { "roomContactTypes": { "type": "array", "items": { "$ref": "#/definitions/RoomContactType" }, "description": "A list of room contact types." } }, "x-ds-definition-name": "GlobalRoomContactTypes", "description": "Contains a list of room contact types.", "x-ms-summary": "Contains a list of room contact types." }, "GlobalSellerDecisionTypes": { "type": "object", "properties": { "sellerDecisionTypes": { "type": "array", "items": { "$ref": "#/definitions/SellerDecisionType" }, "description": "A list of seller decision types." } }, "x-ds-definition-name": "GlobalSellerDecisionTypes", "description": "Contains a list of seller decision types.", "x-ms-summary": "Contains a list of seller decision types." }, "GlobalSpecialCircumstanceTypes": { "type": "object", "properties": { "specialCircumstanceTypes": { "type": "array", "items": { "$ref": "#/definitions/SpecialCircumstanceType" }, "description": "A list of special circumstance types." } }, "x-ds-definition-name": "GlobalSpecialCircumstanceTypes", "description": "Contains a list of special circumstance types.", "x-ms-summary": "Contains a list of special circumstance types." }, "GlobalStates": { "type": "object", "properties": { "states": { "type": "array", "items": { "$ref": "#/definitions/State" }, "description": "A list of states." } }, "x-ds-definition-name": "GlobalStates", "description": "Contains a list of supported states.", "x-ms-summary": "Contains a list of supported states." }, "GlobalTaskDateTypes": { "type": "object", "properties": { "taskDateTypes": { "type": "array", "items": { "$ref": "#/definitions/TaskDateType" }, "description": "A list of task date types." } }, "x-ds-definition-name": "GlobalTaskDateTypes", "description": "Contains a list of task date types.", "x-ms-summary": "Contains a list of task date types." }, "GlobalTaskResponsibilityTypes": { "type": "object", "properties": { "taskResponsibilityTypes": { "type": "array", "items": { "$ref": "#/definitions/TaskResponsibilityType" }, "description": "A list of task responsibility types." } }, "x-ds-definition-name": "GlobalTaskResponsibilityTypes", "description": "Contains a list of task responsibility types.", "x-ms-summary": "Contains a list of task responsibility types." }, "GlobalTaskStatuses": { "type": "object", "properties": { "taskStatuses": { "type": "array", "items": { "$ref": "#/definitions/TaskStatus" }, "description": "" } }, "x-ds-definition-name": "GlobalTaskStatuses", "description": "", "x-ms-summary": "" }, "GlobalTimeZones": { "type": "object", "properties": { "timeZones": { "type": "array", "items": { "$ref": "#/definitions/TimeZone" }, "description": "A list of time zones." } }, "x-ds-definition-name": "GlobalTimeZones", "description": "Contains a list of time zones.", "x-ms-summary": "Contains a list of time zones." }, "GlobalTransactionSides": { "type": "object", "properties": { "transactionSides": { "type": "array", "items": { "$ref": "#/definitions/TransactionSide" }, "description": "A list of transaction sides." } }, "x-ds-definition-name": "GlobalTransactionSides", "description": "Contains a list of transaction sides.", "x-ms-summary": "Contains a list of transaction sides." }, "GroupForm": { "type": "object", "properties": { "formId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the form.\n\nExample: `5be324eb-xxxx-xxxx-xxxx-208065181be9`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "isRequired": { "type": "boolean", "readOnly": true, "description": "**True** if the form is required." }, "lastUpdatedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC date and time when the item was last updated. This is a read-only value that the service assigns.\n\nExample: 2019-07-17T17:45:42.783Z" }, "viewingUserHasAccess": { "type": "boolean", "readOnly": true, "description": "" } }, "x-ds-definition-name": "GroupForm", "description": "Description of a single form in a group.", "x-ms-summary": "Description of a single form in a group." }, "ListingType": { "enum": [ "PublicRecords", "MLS" ], "type": "string", "x-ds-definition-name": "ListingType", "description": "", "x-ms-summary": "" }, "LockedOutDetails": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string", "description": "The reason the account was locked." } }, "x-ds-definition-name": "LockedOutDetails", "description": "Details about a locked account.", "x-ms-summary": "Details about a locked account." }, "MemberSortingOption": { "enum": [ "FirstNameAsc", "LastNameAsc", "EmailAsc", "FirstNameDesc", "LastNameDesc", "EmailDesc" ], "type": "string", "x-ds-definition-name": "MemberSortingOption", "description": "", "x-ms-summary": "" }, "Office": { "required": [ "name" ], "type": "object", "properties": { "officeId": { "format": "int32", "type": "integer", "description": "The ID of the office. This is the ID that the system generated when you created the office." }, "name": { "type": "string", "description": "The name of the office." }, "regionId": { "format": "int32", "type": "integer", "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "address1": { "type": "string", "description": "First line of the office street address." }, "address2": { "type": "string", "description": "Second line of the office street address." }, "city": { "type": "string", "description": "City name or metropolitan area of the office address." }, "stateId": { "type": "string", "description": "A concatenation of the two-letter country code with the state/province/region of the office address.\n\nExample: `US-OH` (for Ohio)" }, "postalCode": { "type": "string", "description": "Postal code or ZIP code of the office address." }, "countryId": { "type": "string", "description": "The two-letter country code of the office address (for example, \"UK\" for United Kingdom)." }, "timeZoneId": { "type": "string", "description": "The ID of the time zone for the office address.\n\nExample: `eastern` (for the Eastern US Time Zone)" }, "phone": { "type": "string", "description": "Phone number of the office." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" } }, "x-ds-definition-name": "Office", "description": "Contains information about an office.", "x-ms-summary": "Contains information about an office." }, "OfficeForCreate": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the office." }, "regionId": { "format": "int32", "type": "integer", "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "address1": { "type": "string", "description": "First line of the office street address." }, "address2": { "type": "string", "description": "Second line of the office street address." }, "city": { "type": "string", "description": "City name or metropolitan area of the office address." }, "stateId": { "type": "string", "description": "A concatenation of the two-letter country code with the state/province/region of the office address.\n\nExample: `US-OH` (for Ohio)" }, "postalCode": { "type": "string", "description": "Postal code or ZIP code of the office address." }, "countryId": { "type": "string", "description": "The two-letter country code of the office address (for example, \"UK\" for United Kingdom)." }, "timeZoneId": { "type": "string", "description": "The ID of the time zone for the office address.\n\nExample: `eastern` (for the Eastern US Time Zone)" }, "phone": { "type": "string", "description": "Phone number of the office." } }, "x-ds-definition-name": "OfficeForCreate", "description": "Contains details about the office that you want to create.", "x-ms-summary": "Contains details about the office that you want to create." }, "OfficeReferenceCount": { "type": "object", "properties": { "referenceType": { "type": "string", "description": "The type of object referencing the office." }, "referencedCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The number of objects of this type referencing the office." } }, "x-ds-definition-name": "OfficeReferenceCount", "description": "A complex element containing the number and type of each object referencing the office.", "x-ms-summary": "A complex element containing the number and type of each object referencing the office." }, "OfficeReferenceCountList": { "type": "object", "properties": { "referencesCounts": { "type": "array", "items": { "$ref": "#/definitions/OfficeReferenceCount" }, "description": "A list of each type of object and the number of objects of that type referencing the office." } }, "x-ds-definition-name": "OfficeReferenceCountList", "description": "Contains a list of each type of object and the number of objects of that type referencing the office.", "x-ms-summary": "Contains a list of each type of object and the number of objects of that type referencing the office." }, "OfficeSummary": { "type": "object", "properties": { "officeId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the office. This is the ID that the system generated when you created the office." }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "regionId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "address1": { "type": "string", "readOnly": true, "description": "First line of the office street address." }, "address2": { "type": "string", "readOnly": true, "description": "Second line of the office street address." }, "city": { "type": "string", "readOnly": true, "description": "City name or metropolitan area of the office address." }, "stateId": { "type": "string", "readOnly": true, "description": "A concatenation of the two-letter country code with the state/province/region of the office address.\n\nExample: `US-OH` (for Ohio)" }, "postalCode": { "type": "string", "readOnly": true, "description": "Postal code or ZIP code of the office address." }, "countryId": { "type": "string", "readOnly": true, "description": "The two-letter country code of the office address (for example, \"UK\" for United Kingdom)." }, "timeZoneId": { "type": "string", "readOnly": true, "description": "The ID of the time zone for the office address.\n\nExample: `eastern` (for the Eastern US Time Zone)" }, "phone": { "type": "string", "readOnly": true, "description": "Phone number of the office." }, "createdDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "UTC datetime that the office was created (for example, \"2019-07-17T17:45:42.783\"). Note that the service assigns this value, so it is read-only." } }, "x-ds-definition-name": "OfficeSummary", "description": "A complex element containing summary information on an office; the elements of this object are identical to those of the `Offices` object.", "x-ms-summary": "A complex element containing summary information on an office; the elements of this object are identical to those of the `Offices` object." }, "OfficeSummaryList": { "type": "object", "properties": { "officeSummaries": { "type": "array", "items": { "$ref": "#/definitions/OfficeSummary" }, "description": "A list of `OfficeSummary` objects containing summary information about an office." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The index position within the total result set from which returned values start." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The index position within the total result set at which returned values end." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "OfficeSummaryList", "description": "Object that contains a summary of information about a requested group of offices in the Rooms account.", "x-ms-summary": "Object that contains a summary of information about a requested group of offices in the Rooms account." }, "OriginOfLead": { "type": "object", "properties": { "originOfLeadId": { "type": "string", "description": "The ID of the origin of lead.\n\nExample: `tru` (for `Trulia`)" }, "name": { "type": "string", "description": "The name of the origin of lead. Possible values are:\n\n- `Realtor.com`\n- `Trulia`\n- `Zillow`\n- `Company Website`\n- `Agent Website`\n- `Other Online`\n- `Mobile App`\n- `Social Media`\n- `Personal Referral`\n- `Company Referral`\n- `Repeat Client`\n- `Corporate Relocation`\n- `Print Marketing`\n- `Prospecting`\n- `Other`\n- `REO (Real Estate Owned)`" } }, "x-ds-definition-name": "OriginOfLead", "description": "Contains information about an origin of lead.", "x-ms-summary": "Contains information about an origin of lead." }, "Permissions": { "type": "object", "properties": { "canAddUsersToRooms": { "type": "boolean", "description": "When **true,** users can see the **Invite** button on the room's **People** tab and can invite people into a room." }, "canCreateRooms": { "type": "boolean", "description": "When **true,** users can see the **New** button on the **Rooms** tab and can create a room." }, "canSubmitRoomsForReview": { "type": "boolean", "description": "When **true,** users can submit rooms for review that are owned by them or someone they manage." }, "canCloseRooms": { "type": "boolean", "description": "When **true,** users can review and close rooms that are owned by them or someone they manage." }, "canReopenRooms": { "type": "boolean", "description": "When **true,** users can reopen rooms that are owned by them or someone they manage." }, "canDeleteOwnedRooms": { "type": "boolean", "description": "When **true,** the user can delete rooms that are owned by them or someone they manage." }, "autoAccessToRooms": { "type": "boolean", "description": "When **true,** users are automatically added to new rooms when someone with an internal role in their office or region creates or is invited to a room." }, "canExportRoomActivityDetailsPeople": { "type": "boolean", "description": "When **true,** users can export the details, people, and history of a room to a PDF or CSV file." }, "canCopyRoomDetails": { "type": "boolean", "description": "When **true,** users see a **Copy** room option in the room **Actions** menu, which copies the room's detail information to populate a new room." }, "canEditAnyRoomRole": { "type": "boolean", "description": "" }, "canEditInvitedRoomRole": { "type": "boolean", "description": "" }, "canEditRoomSide": { "type": "boolean", "description": "" }, "canManageAnyUserRoomAccess": { "type": "boolean", "description": "" }, "canManageInvitedUserRoomAccess": { "type": "boolean", "description": "" }, "isHiddenInRoom": { "type": "boolean", "description": "" }, "canManageRoomOwners": { "type": "boolean", "description": "" }, "canDeleteRooms": { "type": "boolean", "description": "" }, "canConnectToMortgageCadence": { "type": "boolean", "description": "" }, "autoAccessToRoomsInOfficeOnly": { "type": "boolean", "description": "" }, "canViewRoomDetails": { "type": "boolean", "description": "When **true,** users can view all room detail fields that the company Admin has set to **Use.**" }, "canViewAndEditRoomDetails": { "type": "boolean", "description": "When **true,** users can view and make edits to any room detail fields." }, "canSendRoomDetailsToLoneWolf": { "type": "boolean", "description": "" }, "canAddDocuments": { "type": "boolean", "description": "When **true,** users can add documents to rooms and share the documents that they own with other people in the room." }, "canAddDocumentsFromFormGroups": { "type": "boolean", "description": "When **true,** users can add documents from form groups to rooms." }, "canAddDocumentsFromFormLibraries": { "type": "boolean", "description": "When **true,** users can add documents from form libraries to rooms." }, "documentsViewableByOthersInRoomFromOffice": { "type": "boolean", "description": "When a user for whom this permission is set to **true** adds a document, the document is automatically shared with other room users that are in the user's office." }, "documentsAutoOwnedByPeers": { "type": "boolean", "description": "When a user for whom this permission is set to **true** adds a document, the document is automatically seen and owned by those users' peers. Peers are others in the same office or region who have the same access level as the user." }, "canDeleteOwnedDocuments": { "type": "boolean", "description": "When **true,** users can delete documents that they own from rooms." }, "canDeleteSignedDocuments": { "type": "boolean", "description": "" }, "canDeleteUnsignedDocuments": { "type": "boolean", "description": "" }, "canManageSharedDocs": { "type": "boolean", "description": "When **true,** users can manage all documents, including ones that another user has shared with them." }, "canManageFormGroups": { "type": "boolean", "description": "When **true,** users have access to **Admin > Forms** and can manage form groups and form libraries for the company." }, "canShareDocsNotOwned": { "type": "boolean", "description": "When **true,** users can share documents that they do not own (documents that another user has shared with them)." }, "canCreateFormTemplates": { "type": "boolean", "description": "" }, "canManageFormPackets": { "type": "boolean", "description": "" }, "canAddTasksToAnyTaskLists": { "type": "boolean", "description": "When **true,** users can add tasks to any task list, including lists that they do not own." }, "canEditEditableTasks": { "type": "boolean", "description": "When **true,** users can edit editable tasks." }, "canEditAnyTasks": { "type": "boolean", "description": "When **true,** users can edit tasks in rooms, even if the task owner has not marked the task as editable." }, "canDeleteDeletableTasks": { "type": "boolean", "description": "When **true,** users can delete deletable tasks." }, "canDeleteAnyTasks": { "type": "boolean", "description": "When **true,** users can delete tasks, even if the task owner has not marked the task as deletable." }, "canApplyTaskList": { "type": "boolean", "description": "When **true,** users see the **Attach Task List** option in the room's **Actions** menu and can apply task lists to rooms." }, "canRemoveAnyTaskList": { "type": "boolean", "description": "When **true,** users can use the **Remove Task List** option in the room's **Actions** menu to remove task lists owned by others.\n\n**Note:** Users can already remove task lists that they own." }, "canSubmitTaskList": { "type": "boolean", "description": "When **true,** users can use the **Submit Task List** option in the room's **Actions** menu to submit task lists for review." }, "canAutoSubmitTaskList": { "type": "boolean", "description": "When **true,** users can use the **Submit Task List** option in the room's **Actions** menu to submit task lists for review." }, "canReviewTaskList": { "type": "boolean", "description": "When **true,** users can approve or decline a task list. Declining a task list sends it back to open status for the assignee to complete. The assignee also receives a notification." }, "canAutoApproveTaskList": { "type": "boolean", "description": "When **true** and a room is approved, the task lists associated with the room auto-approve if all of the tasks are approved." }, "canManageTaskTemplatesForAllRegionsAllOffices": { "type": "boolean", "description": "When **true,** users have access to the **Admin > Company > Task List Templates** menu so that they can create, edit, and delete task list templates for all regions and offices." }, "canApplyRoomTemplates": { "type": "boolean", "description": "When **true,** users can apply a room template when they create a room." }, "canAddTasksToRooms": { "type": "boolean", "description": "When **true,** users can add tasks to rooms." }, "canReviewAnyTask": { "type": "boolean", "description": "" }, "canManageDocsOnAnyTask": { "type": "boolean", "description": "" }, "canAddMemberAndSetRoleLowerAccessLevel": { "type": "boolean", "description": "When **true,** users can add other users with a lower access level than their own to offices or regions that they oversee and set those users' roles." }, "canAddMemberAndSetRoleSameAccessLevel": { "type": "boolean", "description": "When **true,** users can add other users with the same access level as their own to offices or regions that they oversee and set those users' roles." }, "canChangeMemberRoleLowerAccessLevel": { "type": "boolean", "description": "When **true,** users can edit the roles of other users who have a lower access level than their own and that belong to offices or regions that they oversee." }, "canChangeMemberRoleSameAccessLevel": { "type": "boolean", "description": "When **true,** users can edit the roles of other users who have the same access level as their own and that belong to offices or regions that they oversee." }, "canManageMemberLowerAccessLevel": { "type": "boolean", "description": "When **true,** users can change the access level, office, region, and eSignature permission set of other users who have a lower access level than their own." }, "canManageMemberSameAccessLevel": { "type": "boolean", "description": "When **true,** users can change the access level, office, region, and eSignature permission set of other users who have the same access level as their own." }, "canRemoveCompanyMemberLowerAccessLevel": { "type": "boolean", "description": "When **true,** users can remove other users who have a lower access level than their own and that belong to offices or regions that they oversee from the company account." }, "canRemoveCompanyMemberSameAccessLevel": { "type": "boolean", "description": "When **true,** users can remove other users who have the same access level as their own and that belong to offices or regions that they oversee from the company account." }, "canManageAccount": { "type": "boolean", "description": "When **true,** users can access the **Company Settings** tab under **Rooms > Admin > Company** to manage company account settings and change the company name, contact information, currency, offices, and regions." }, "canManageLogo": { "type": "boolean", "description": "When **true,** users can access the **Company Logo** section in **Company Settings** to add or change the company logo." }, "canManageRolesAndPermissions": { "type": "boolean", "description": "" }, "canManageRoomDetails": { "type": "boolean", "description": "When **true,** users see the **Room Details** tab under **Rooms > Admin > Company** and can use it to configure room details. They can also add additional contact fields." }, "canManageRoomTemplates": { "type": "boolean", "description": "When **true,** users see the **Room Templates** option in the **Rooms > Admin** menu, which enables them to add, edit, and delete room templates." }, "canManageIntegrationSettings": { "type": "boolean", "description": "" }, "canExportCompanyUsageReport": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "Permissions", "description": "Contains details about permissions.", "x-ms-summary": "Contains details about permissions." }, "ProductVersion": { "enum": [ "v5", "v6" ], "type": "string", "x-ds-definition-name": "ProductVersion", "description": "", "x-ms-summary": "" }, "PropertyType": { "type": "object", "properties": { "propertyTypeId": { "type": "string", "description": "The ID of the property type.\n\nExample: `resd` (for `Residential Detached`)" }, "name": { "type": "string", "description": "The name of the property type. Possible values are:\n\n- `Residential Detached`\n- `Residential Attached`\n- `New Construction`\n- `Residential Developed Lots`\n- `Land/Farm`\n- `Rental`\n- `Commercial`\n- `Condominium`\n- `Mobile Home`\n" } }, "x-ds-definition-name": "PropertyType", "description": "Contains information about a property type.", "x-ms-summary": "Contains information about a property type." }, "Region": { "required": [ "name" ], "type": "object", "properties": { "regionId": { "format": "int32", "type": "integer", "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "name": { "type": "string", "description": "The name of the office." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" } }, "x-ds-definition-name": "Region", "description": "Contains information about a region.", "x-ms-summary": "Contains information about a region." }, "RegionReferenceCount": { "type": "object", "properties": { "referenceType": { "type": "string", "description": "The type of object referencing the region." }, "referenceCount": { "format": "int32", "type": "integer", "description": "The number of objects of this type referencing the region." } }, "x-ds-definition-name": "RegionReferenceCount", "description": "A complex element containing the number and type of each object referencing the region.", "x-ms-summary": "A complex element containing the number and type of each object referencing the region." }, "RegionReferenceCountList": { "type": "object", "properties": { "referenceCounts": { "type": "array", "items": { "$ref": "#/definitions/RegionReferenceCount" }, "description": "A list of each type of object and the number of objects of that type referencing the region." } }, "x-ds-definition-name": "RegionReferenceCountList", "description": "Contains a list of each type of object and the number of objects of that type referencing the region.", "x-ms-summary": "Contains a list of each type of object and the number of objects of that type referencing the region." }, "RegionSummary": { "type": "object", "properties": { "regionId": { "format": "int32", "type": "integer", "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "name": { "type": "string", "description": "String that specifies the region name." }, "createdDate": { "format": "date-time", "type": "string", "description": "UTC datetime that the region was created (for example \"2019-06-27T19:32:46.943\"). Note that the service assigns this value, so it is read-only." } }, "x-ds-definition-name": "RegionSummary", "description": "A complex element containing summary information on a region; the elements of this object are identical to those of the `Regions` object.", "x-ms-summary": "A complex element containing summary information on a region; the elements of this object are identical to those of the `Regions` object." }, "RegionSummaryList": { "type": "object", "properties": { "regionSummaries": { "type": "array", "items": { "$ref": "#/definitions/RegionSummary" }, "description": "A list of `RegionSummary` objects containing summary information on a region; the elements of this object are identical to those of the `Regions` object." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "RegionSummaryList", "description": "Object that contains a summary of information about a requested group of regions in the Rooms account.", "x-ms-summary": "Object that contains a summary of information about a requested group of regions in the Rooms account." }, "Role": { "type": "object", "properties": { "roleId": { "format": "int32", "type": "integer", "description": "The ID of the company role assigned to the user." }, "legacyRoleId": { "type": "string", "description": "This field is deprecated in Rooms Version 6." }, "name": { "type": "string", "description": "The name of the role." }, "isDefaultForAdmin": { "type": "boolean", "description": "When **true,** the role is the default for account administrators." }, "isExternal": { "type": "boolean", "description": "When **true,** the role is an external role. You assign external roles to people from outside your company when you invite them into a room." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" }, "isAssigned": { "type": "boolean", "description": "When **true,** indicates that this role is currently assigned to a user." }, "permissions": { "$ref": "#/definitions/Permissions", "description": "This object is deprecated in Rooms Version 6." } }, "x-ds-definition-name": "Role", "description": "Contains details about a company role.", "x-ms-summary": "Contains details about a company role." }, "RoleForCreate": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the role." }, "isExternal": { "type": "boolean", "description": "When **true,** the role is an external role. You assign external roles to people from outside your company when you invite them into a room." }, "permissions": { "$ref": "#/definitions/Permissions", "description": "An object that contains details about the permissions associated with the role." } }, "x-ds-definition-name": "RoleForCreate", "description": "Contains details about the role that you want to create.", "x-ms-summary": "Contains details about the role that you want to create." }, "RoleForUpdate": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the role." }, "isExternal": { "type": "boolean", "description": "When **true,** the role is an external role. You assign external roles to people from outside your company when you invite them into a room." }, "permissions": { "$ref": "#/definitions/Permissions", "description": "An object that contains details about the permissions associated with the role." } }, "x-ds-definition-name": "RoleForUpdate", "description": "This request object contains the details to use for the update.", "x-ms-summary": "This request object contains the details to use for the update." }, "RoleSummary": { "type": "object", "properties": { "roleId": { "format": "int32", "type": "integer", "description": "The ID of the company role assigned to the user." }, "legacyRoleId": { "type": "string", "description": "This field is deprecated in Rooms Version 6." }, "name": { "type": "string", "description": "The name of the role." }, "isDefaultForAdmin": { "type": "boolean", "description": "When **true,** the role is the default for account administrators." }, "isExternal": { "type": "boolean", "description": "When **true,** the role is an external role. You assign external roles to people from outside your company when you invite them into a room." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" } }, "x-ds-definition-name": "RoleSummary", "description": "Contains details about a role.", "x-ms-summary": "Contains details about a role." }, "RoleSummaryList": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleSummary" }, "description": "An array of `role` objects." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "RoleSummaryList", "description": "This complex type contains details about the roles that are associated with an account.", "x-ms-summary": "This complex type contains details about the roles that are associated with an account." }, "RolesFilterContextTypes": { "enum": [ "AllRoles", "AssignableRolesBasedOnCompanyPermissions", "AssignableRolesBasedOnAllPermissions" ], "type": "string", "x-ds-definition-name": "RolesFilterContextTypes", "description": "", "x-ms-summary": "" }, "Room": { "type": "object", "properties": { "roomId": { "format": "int32", "type": "integer", "description": "The ID of the room." }, "companyId": { "format": "int32", "type": "integer", "description": "The ID of the company." }, "name": { "type": "string", "description": "The name of the room." }, "officeId": { "format": "int32", "type": "integer", "description": "The ID of the office. This is the ID that the system generated when you created the office." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" }, "submittedForReviewDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the room was submitted for review. This is when a member with a role for which the **Submit rooms for review** permission is set to **true** submitted the room to a member with a role for which the **Review and close rooms** permission is set to **true.**" }, "closedDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the room was closed." }, "rejectedDate": { "format": "date-time", "type": "string", "description": "The date on which the reviewer rejected the room. For example, a reviewer might reject closing a room if documentation is missing or the details are inaccurate." }, "createdByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who created the room." }, "roomOwnerIds": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "" }, "rejectedByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who rejected the room." }, "closedStatusId": { "type": "string", "description": "The reason why a room was closed. Possible values are:\n\n- `sold`: Property sold.\n- `dup`: Duplicate room.\n- `escrcncl`: Escrow canceled.\n- `inspctn`: Inspection issues.\n- `exp`: Listing expired.\n- `lostbuy`: Buyer withdrew.\n- `list`: Listing withdrawn. \n- `newlist`: New listing.\n- `offrrjct`: Offer not accepted.\n- `pend`: Pending. An agent might use this status to temporarily hide a room from their Active rooms view if they are blocked on a task. When they are ready to reopen the room, they can quickly find it by filtering for rooms in `pending` status.\n- `lstcanc`: Listing canceled. \n- `lstleave`: Listing released.\n- `sellwtdw`: Seller withdrew.\n- `nofin`: Buyer unable to finance.\n- `disciss`: Property disclosure issue.\n- `appiss`: Appraisal issues.\n- `mtgiss`: Mortgage issues. Use when details about why the buyer wasn't able to obtain financing are unknown.\n- `zoniss`: Zoning issues.\n- `attiss`: Attorney review issues.\n- `proplsd`: Property leased. Use for the list side of the transaction.\n- `tenlease`: Tenant signed lease. Use when an agent helps renters find a to lease. " }, "fieldDataLastUpdatedDate": { "format": "date-time", "type": "string", "description": "" }, "fieldData": { "$ref": "#/definitions/FieldData", "description": "The field data associated with a room.\nSee [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/)." } }, "x-ds-definition-name": "Room", "description": "Contains details about a room.", "x-ms-summary": "Contains details about a room." }, "RoomContactType": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the room contact type.\n\nExample: `lisagent` (for `Listing Agent`)" }, "name": { "type": "string", "description": "The name of the room contact type. Possible values are:\n\n- `Seller`\n- `Listing Agent`\n- `Buyer`\n- `Buyer Agent`\n- `Service Provider`\n- `Transaction Coordinator`\n- `Mortgage Provider`\n- `Title Provider`\n- `Insurance Provider`\n- `Home Warranty Provider`\n- `Survey Provider`\n- `Escrow Provider`\n- `Buyer Broker`\n- `Listing Broker`" } }, "x-ds-definition-name": "RoomContactType", "description": "Contains information about a room contact type.", "x-ms-summary": "Contains information about a room contact type." }, "RoomDocument": { "type": "object", "properties": { "documentId": { "format": "int32", "type": "integer", "description": "The ID of the document." }, "name": { "type": "string", "description": "The file name of the document.\n\nExample: `Short Sale Supplement to Marketing Agreement.pdf`" }, "ownerId": { "format": "int32", "type": "integer", "description": "The ID of the user who owns the document." }, "size": { "format": "int64", "type": "integer", "description": "The size of the document in bytes." }, "folderId": { "format": "int32", "type": "integer", "description": "The ID of the folder the document is in." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time that the document was created or uploaded. \n\nExample: `2019-07-25T22:18:56.95Z`\n" }, "isSigned": { "type": "boolean", "description": "When **true,** this property indicates that the document is signed." }, "docuSignFormId": { "type": "string", "description": "The ID of the corresponding DocuSign form." }, "isArchived": { "type": "boolean", "description": "**True** if the document is archived." }, "isVirtual": { "type": "boolean", "description": "**True** if the document is virtual." }, "isDynamic": { "type": "boolean", "description": "**True** if the document is from a dynamic content provider like [DocuSign Forms](/docs/rooms-api/rooms101/forms/)." }, "owner": { "$ref": "#/definitions/RoomDocumentOwner", "description": "The owner of the document." } }, "x-ds-definition-name": "RoomDocument", "description": "An individual document in a room.", "x-ms-summary": "An individual document in a room." }, "RoomDocumentList": { "type": "object", "properties": { "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/RoomDocument" }, "description": "An array of room documents." } }, "x-ds-definition-name": "RoomDocumentList", "description": "A list of documents in a room.", "x-ms-summary": "A list of documents in a room." }, "RoomDocumentOwner": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "description": "The ID of the user." }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "companyName": { "type": "string", "description": "The company name." }, "imageSrc": { "type": "string", "description": "The source of the user's profile picture." } }, "x-ds-definition-name": "RoomDocumentOwner", "description": "", "x-ms-summary": "" }, "RoomFolder": { "type": "object", "properties": { "roomFolderId": { "format": "int32", "type": "integer", "description": "The ID of the folder." }, "name": { "type": "string", "description": "The name of the folder." }, "isDefault": { "type": "boolean", "description": "When **true,** this is the default folder." } }, "x-ds-definition-name": "RoomFolder", "description": "Information about a room folder.", "x-ms-summary": "Information about a room folder." }, "RoomFolderList": { "type": "object", "properties": { "folders": { "type": "array", "items": { "$ref": "#/definitions/RoomFolder" }, "description": "An array of room folders." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "RoomFolderList", "description": "A list of room folder results.", "x-ms-summary": "A list of room folder results." }, "RoomForCreate": { "required": [ "name", "roleId" ], "type": "object", "properties": { "name": { "type": "string", "description": "(Required) The name of the room." }, "roleId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the role that the owner has in the room." }, "transactionSideId": { "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`\n\n**Note:** This property is required for real estate companies, and otherwise ignored.", "type": "string" }, "ownerId": { "format": "int32", "type": "integer", "description": "The ID of the user who owns the room." }, "templateId": { "format": "int32", "type": "integer", "description": "(Optional) The ID of the template to use to create the room." }, "officeId": { "format": "int32", "type": "integer", "description": "(Optional) The ID of the office associated with the room. Required when creating a room on behalf of someone else or a Manager-owned room. " }, "fieldData": { "$ref": "#/definitions/FieldDataForCreate", "description": "The details to use for the room, such as `yearBuilt` and `originalListingAmount`. This is the information that appears on a room's Details tab. Note that `address1`, `state`, `postalCode`, and `city` are required fields. \n\nTo determine the fields for which you can provide data, use the Fields: GetFieldSet method." }, "listingSource": { "enum": [ "PublicRecords", "MLS" ], "type": "string", "description": "" } }, "x-ds-definition-name": "RoomForCreate", "description": "This request object contains the details about the new room.", "x-ms-summary": "This request object contains the details about the new room." }, "RoomInvite": { "required": [ "email", "firstName", "lastName", "roleId" ], "type": "object", "properties": { "email": { "type": "string", "description": "The user's email address." }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "roleId": { "format": "int32", "type": "integer", "description": "The ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization." }, "transactionSideId": { "description": "Required for a real estate company; otherwise ignored.", "type": "string" } }, "x-ds-definition-name": "RoomInvite", "description": "The information to use for the invitation.", "x-ms-summary": "The information to use for the invitation." }, "RoomInviteResponse": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user." }, "roomId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the room." }, "email": { "type": "string", "readOnly": true, "description": "The user's email address." }, "firstName": { "type": "string", "readOnly": true, "description": "The user's first name." }, "lastName": { "type": "string", "readOnly": true, "description": "The user's last name." }, "transactionSideId": { "type": "string", "readOnly": true, "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`" }, "roleId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization." } }, "x-ds-definition-name": "RoomInviteResponse", "description": "Information about the sent invitation.", "x-ms-summary": "Information about the sent invitation." }, "RoomPicture": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL for the uploaded picture." } }, "x-ds-definition-name": "RoomPicture", "description": "This response object contains the URL for the uploaded picture.", "x-ms-summary": "This response object contains the URL for the uploaded picture." }, "RoomStatus": { "enum": [ "Active", "Pending", "Closed", "Open" ], "type": "string", "x-ds-definition-name": "RoomStatus", "description": "", "x-ms-summary": "" }, "RoomSummary": { "type": "object", "properties": { "roomId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the room." }, "name": { "type": "string", "readOnly": true, "description": "The name of the room." }, "officeId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the office. This is the ID that the system generated when you created the office." }, "createdDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" }, "submittedForReviewDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC DateTime when the room was submitted for review. This is when a member with a role for which the **Submit rooms for review** permission is set to **true** submitted the room to a member with a role for which the **Review and close rooms** permission is set to **true.**" }, "closedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC date and time when the room was closed." }, "rejectedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The date on which the reviewer rejected the room. For example, a reviewer might reject closing a room if documentation is missing or the details are inaccurate." }, "createdByUserId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user who created the room." }, "rejectedByUserId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user who rejected the room." }, "closedStatusId": { "type": "string", "readOnly": true, "description": "The reason why a room was closed. Possible values are:\n\n- `sold`: Property sold.\n- `dup`: Duplicate room.\n- `escrcncl`: Escrow canceled.\n- `inspctn`: Inspection issues.\n- `exp`: Listing expired.\n- `lostbuy`: Buyer withdrew.\n- `list`: Listing withdrawn. \n- `newlist`: New listing.\n- `offrrjct`: Offer not accepted.\n- `pend`: Pending. An agent might use this status to temporarily hide a room from their Active rooms view if they are blocked on a task. When they are ready to reopen the room, they can quickly find it by filtering for rooms in `pending` status.\n- `lstcanc`: Listing canceled. \n- `lstleave`: Listing released.\n- `sellwtdw`: Seller withdrew.\n- `nofin`: Buyer unable to finance.\n- `disciss`: Property disclosure issue.\n- `appiss`: Appraisal issues.\n- `mtgiss`: Mortgage issues. Use when details about why the buyer wasn't able to obtain financing are unknown.\n- `zoniss`: Zoning issues.\n- `attiss`: Attorney review issues.\n- `proplsd`: Property leased. Use for the list side of the transaction.\n- `tenlease`: Tenant signed lease. Use when an agent helps renters find a to lease. " }, "fieldDataLastUpdatedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "" } }, "x-ds-definition-name": "RoomSummary", "description": "This object contains details about a room.", "x-ms-summary": "This object contains details about a room." }, "RoomSummaryList": { "type": "object", "properties": { "rooms": { "type": "array", "items": { "$ref": "#/definitions/RoomSummary" }, "description": "An array of `roomSummary` objects." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "RoomSummaryList", "description": "This complex type contains details about rooms.", "x-ms-summary": "This complex type contains details about rooms." }, "RoomTemplate": { "type": "object", "properties": { "roomTemplateId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the room template." }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "taskTemplateCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The total number of task templates that the room template uses." } }, "x-ds-definition-name": "RoomTemplate", "description": "Contains details about a room template.", "x-ms-summary": "Contains details about a room template." }, "RoomTemplatesSummaryList": { "type": "object", "properties": { "roomTemplates": { "type": "array", "items": { "$ref": "#/definitions/RoomTemplate" }, "description": "An array of `roomTemplate` objects." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "RoomTemplatesSummaryList", "description": "This complex type contains information about room templates.", "x-ms-summary": "This complex type contains information about room templates." }, "RoomUser": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "description": "The ID of the user." }, "email": { "type": "string", "description": "The user's email address." }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "transactionSideId": { "type": "string", "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`" }, "roleId": { "format": "int32", "type": "integer", "description": "The ID of the user's role." }, "isRevoked": { "type": "boolean", "description": "When **true,** indicates that the user's access to the room has been revoked." }, "invitedByUserId": { "format": "int32", "type": "integer", "description": "The `userId` of the person who invited the room user to the room." } }, "x-ds-definition-name": "RoomUser", "description": "This object contains details about a specific room member.", "x-ms-summary": "This object contains details about a specific room member." }, "RoomUserForUpdate": { "type": "object", "properties": { "roleId": { "format": "int32", "type": "integer", "description": "The ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization." }, "transactionSideId": { "type": "string", "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`" } }, "x-ds-definition-name": "RoomUserForUpdate", "description": "This request object contains the information that you want to update for the room user.", "x-ms-summary": "This request object contains the information that you want to update for the room user." }, "RoomUserRemovalDetail": { "type": "object", "properties": { "revocationDate": { "format": "date-time", "type": "string", "description": "The date on which the users room access should be revoked\nin ISO 8601 fomat: `1973-12-31T07:54Z`." } }, "x-ds-definition-name": "RoomUserRemovalDetail", "description": "Details for removal.", "x-ms-summary": "Details for removal." }, "RoomUserSortingOption": { "enum": [ "FirstNameAsc", "LastNameAsc", "EmailAsc", "FirstNameDesc", "LastNameDesc", "EmailDesc" ], "type": "string", "x-ds-definition-name": "RoomUserSortingOption", "description": "", "x-ms-summary": "" }, "RoomUserSummary": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user." }, "email": { "type": "string", "readOnly": true, "description": "The user's email address." }, "firstName": { "type": "string", "readOnly": true, "description": "The user's first name." }, "lastName": { "type": "string", "readOnly": true, "description": "The user's last name." }, "transactionSideId": { "type": "string", "readOnly": true, "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`" }, "roleId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization." }, "titleId": { "format": "int32", "type": "integer", "readOnly": true, "description": "Deprecated in Rooms Version 6." }, "companyName": { "type": "string", "readOnly": true, "description": "The company name." }, "roleName": { "type": "string", "readOnly": true, "description": "" } }, "x-ds-definition-name": "RoomUserSummary", "description": "Contains details about a room user.", "x-ms-summary": "Contains details about a room user." }, "RoomUsersResult": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/definitions/RoomUserSummary" }, "description": "An array of `RoomUser` objects." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "RoomUsersResult", "description": "This complex type contains details about the users associated with a room.", "x-ms-summary": "This complex type contains details about the users associated with a room." }, "SelectListFieldOption": { "type": "object", "properties": { "id": { "readOnly": true, "description": "The ID of the list option.\n\nExample: `AU`" }, "title": { "type": "string", "readOnly": true, "description": "The title or name of the list option.\n\nExample: `Australia`" }, "order": { "format": "int32", "type": "integer", "readOnly": true, "description": "The order of the list option in the list.\n\nExample: `3`" } }, "x-ds-definition-name": "SelectListFieldOption", "description": "Contains details about an option in a list.", "x-ms-summary": "Contains details about an option in a list." }, "SellerDecisionType": { "type": "object", "properties": { "sellerDecisionTypeId": { "type": "string", "description": "The ID of the seller decision type.\n\nExample: `appr` (for `Approved`)" }, "name": { "type": "string", "description": "The name of the seller decision type. Possible values are:\n\n- `Pending`\n- `Approved`\n- `Countered`\n- `Rejected`\n- `Pending Rejection`" } }, "x-ds-definition-name": "SellerDecisionType", "description": "Contains information about a seller decision type.", "x-ms-summary": "Contains information about a seller decision type." }, "SpecialCircumstanceType": { "type": "object", "properties": { "specialCircumstanceTypeId": { "type": "string", "description": "The ID of the special circumstance type.\n\nExample: `ss` (for `Short Sale`)" }, "name": { "type": "string", "description": "The name of the special circumstance type. Possible values are:\n\n- `Short Sale`\n- `Foreclosure`\n- `Corporate Owned`\n- `Historical`\n- `Investor Owned`\n- `HUD`\n- `Estate Sale`\n- `Relocation`\n- `Contingency`" } }, "x-ds-definition-name": "SpecialCircumstanceType", "description": "Contains information about a special circumstance type.", "x-ms-summary": "Contains information about a special circumstance type." }, "State": { "type": "object", "properties": { "stateId": { "type": "string", "description": "A concatenation of the two-letter country code with the state/province/region of the office address.\n\nExample: `US-OH` (for Ohio)" }, "name": { "type": "string", "description": "The name of the state. Possible values are:\n\n- `Alberta`\n- `Auckland`\n- `New South Wales`\n- `Alabama`\n- `Alaska`\n- `Bay of Plenty`\n- `British Columbia`\n- `Queensland`\n- `South Australia`\n- `Manitoba`\n- `Canterbury`\n- `Arizona`\n- `Arkansas`\n- `New Brunswick`\n- `Tasmania`\n- `Hawke's Bay`\n- `Manawatu-Wanganui`\n- `Victoria`\n- `Newfoundland and Labrador`\n- `California`\n- `Colorado`\n- `Western Australia`\n- `Northwest Territories`\n- `Northland`\n- `Otago`\n- `Australian Capital Territory`\n- `Nova Scotia`\n- `Connecticut`\n- `Delaware`\n- `Nunavut`\n- `Northern Territory`\n- `Southland`\n- `Taranaki`\n- `Ontario`\n- `District of Columbia`\n- `Florida`\n- `Prince Edward Island`\n- `Waikato`\n- `Wellington`\n- `Quebec`\n- `Georgia`\n- `Guam`\n- `Saskatchewan`\n- `West Coast`\n- `Gisborne District`\n- `Yukon`\n- `Hawaii`\n- `Idaho`\n- `Marlborough District`\n- `Nelson City`\n- `Illinois`\n- `Indiana`\n- `Tasman District`\n- `Chatham Islands Territory`\n- `Iowa`\n- `Kansas`\n- `Kentucky`\n- `Louisiana`\n- `Maine`\n- `Maryland`\n- `Massachusetts`\n- `Michigan`\n- `Minnesota`\n- `Mississippi`\n- `Missouri`\n- `Montana`\n- `Nebraska`\n- `Nevada`\n- `New Hampshire`\n- `New Jersey`\n- `New Mexico`\n- `New York`\n- `North Carolina`\n- `North Dakota`\n- `Ohio`\n- `Oklahoma`\n- `Oregon`\n- `Pennsylvania`\n- `Puerto Rico`\n- `Rhode Island`\n- `South Carolina`\n- `South Dakota`\n- `Tennessee`\n- `Texas`\n- `US Virgin Islands`\n- `Utah`\n- `Vermont`\n- `Virginia`\n- `Washington`\n- `West Virginia`\n- `Wisconsin`\n- `Wyoming`" } }, "x-ds-definition-name": "State", "description": "Contains information about a state.", "x-ms-summary": "Contains information about a state." }, "TaskDateType": { "type": "object", "properties": { "taskDateTypeId": { "type": "string", "description": "The ID of the task date type.\n\nExample: `tdd` (for `Task Due Date`)" }, "name": { "type": "string", "description": "The name of the task date type. \n\nPossible values are:\n\n- `Specific Calendar Date`\n- `Task Due Date`\n- `Actual Close Date`\n- `Binding Date`\n- `Contingency Removal Date`\n- `Contract Date`\n- `Expected Closing Date`\n- `Listing Date`\n- `Listing Expiration Date`\n- `Offer Date`" } }, "x-ds-definition-name": "TaskDateType", "description": "Contains information about a task date type.", "x-ms-summary": "Contains information about a task date type." }, "TaskList": { "type": "object", "properties": { "taskListId": { "format": "int32", "type": "integer", "description": "The ID of the task list." }, "name": { "type": "string", "description": "The name of the task list." }, "taskListTemplateId": { "format": "int32", "type": "integer", "description": "The ID of the task list template used to create the task list." }, "submittedForReviewDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the task list was submitted for review." }, "approvalDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the task list was approved." }, "rejectedDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the reviewer rejected the task list. " }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the task list was created. This is a read-only value that the service assigns.\n\nExample: 2019-07-17T17:45:42.783Z" }, "approvedByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who approved the task list." }, "rejectedByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who rejected the task list." }, "comment": { "type": "string", "description": "Contains a comment about the task list." }, "tasks": { "type": "array", "items": { "$ref": "#/definitions/TaskSummary" }, "description": "A list of tasks in the task list." } }, "x-ds-definition-name": "TaskList", "description": "This response object contains details about the new task list.", "x-ms-summary": "This response object contains details about the new task list." }, "TaskListForCreate": { "type": "object", "properties": { "taskListTemplateId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the task list template." } }, "x-ds-definition-name": "TaskListForCreate", "description": "Contains information about the task list template to use to create the new task list.", "x-ms-summary": "Contains information about the task list template to use to create the new task list." }, "TaskListSummary": { "type": "object", "properties": { "taskListId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the task list." }, "name": { "type": "string", "readOnly": true, "description": "The name of the task list." }, "taskListTemplateId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the task list template." }, "submittedForReviewDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC DateTime when the task list was submitted for review." }, "approvalDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC DateTime when the task list was approved." }, "rejectedDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The date on which the reviewer rejected the task list." }, "createdDate": { "format": "date-time", "type": "string", "readOnly": true, "description": "The UTC date and time when the task list was created. This is a read-only value that the service assigns.\n\nExample: 2019-07-17T17:45:42.783Z" }, "approvedByUserId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user who approved the task list." }, "rejectedByUserId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user who rejected the task list." }, "comment": { "type": "string", "readOnly": true, "description": "Contains a user comment about the task list." } }, "x-ds-definition-name": "TaskListSummary", "description": "Contains information about a task list.", "x-ms-summary": "Contains information about a task list." }, "TaskListSummaryList": { "type": "object", "properties": { "taskListSummaries": { "type": "array", "items": { "$ref": "#/definitions/TaskListSummary" }, "description": "A list of task list summaries." } }, "x-ds-definition-name": "TaskListSummaryList", "description": "Contains a list of task list summaries.", "x-ms-summary": "Contains a list of task list summaries." }, "TaskListTemplate": { "type": "object", "properties": { "taskListTemplateId": { "format": "int32", "type": "integer", "description": "The ID of the task list template." }, "name": { "type": "string", "description": "The name of the task list template." }, "taskCount": { "format": "int32", "type": "integer", "description": "The total number of tasks in the task list template." }, "tasksWithDocumentsCount": { "format": "int32", "type": "integer", "description": "The number of tasks in the task list template that have documents associated with them." } }, "x-ds-definition-name": "TaskListTemplate", "description": "Contains details about a task list template.", "x-ms-summary": "Contains details about a task list template." }, "TaskListTemplateList": { "type": "object", "properties": { "taskListTemplates": { "type": "array", "items": { "$ref": "#/definitions/TaskListTemplate" }, "description": "A list of task list templates." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "TaskListTemplateList", "description": "Contains a list of task list templates.", "x-ms-summary": "Contains a list of task list templates." }, "TaskResponsibilityType": { "type": "object", "properties": { "taskResponsibilityTypeId": { "type": "string", "description": "The ID of the task responsibility type." }, "name": { "type": "string", "description": "The name of the task responsibility type. Valid values:\n\n- `Assignee`\n- `Watcher`\n- `Reviewer`" } }, "x-ds-definition-name": "TaskResponsibilityType", "description": "Contains information about a task responsibility type.", "x-ms-summary": "Contains information about a task responsibility type." }, "TaskStatus": { "type": "object", "properties": { "taskStatusId": { "type": "string", "description": "" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "TaskStatus", "description": "", "x-ms-summary": "" }, "TaskSummary": { "type": "object", "properties": { "taskId": { "format": "int32", "type": "integer", "description": "The ID of the task list." }, "name": { "type": "string", "description": "The name of the task list." }, "requiresApproval": { "type": "boolean", "description": "When **true,** the task must be completed and reviewed before it can be closed." }, "dueDateTypeId": { "type": "string", "description": "The ID of the due date type (such as Actual Close Date or Contract Date)." }, "dueDateOffset": { "format": "int32", "type": "integer", "description": "The number of days before or after the due date (specified by the `dueDateTypeId`) within which the task must be completed. A negative number indicates that the task must be completed within a certain number of days before the due date. A positive number indicates that the task must be completed within a certain number of days after the due date." }, "fixedDueDate": { "format": "date-time", "type": "string", "description": "A specific calendar due date for the task.\n\nIn the API, this value is a UTC DateTime that does not actually include a time.\n\nExample: 2019-07-17T00:00:00.000Z" }, "ownerUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who owns the task." }, "completionDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the task was completed.\n\nExample: 2019-07-17T17:45:42.783Z" }, "approvalDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the task was approved.\n\nExample: 2019-07-17T17:45:42.783Z" }, "rejectedDate": { "format": "date-time", "type": "string", "description": "The date on which the reviewer rejected the task." }, "createdDate": { "format": "date-time", "type": "string", "description": "\t\nThe UTC date and time when the task was created. This is a read-only value that the service assigns.\n\nExample: 2019-07-17T17:45:42.783Z" }, "isDocumentTask": { "type": "boolean", "description": "When **true,** the task is associated with a document." }, "requiresReview": { "type": "boolean", "description": "When **true,** the task is optional. If the task is completed (if a document is added or the task is marked complete), it must be reviewed before it can be closed." } }, "x-ds-definition-name": "TaskSummary", "description": "Contains information about a task list.", "x-ms-summary": "Contains information about a task list." }, "TimeZone": { "type": "object", "properties": { "timeZoneId": { "type": "string", "description": "The ID of the time zone.\n\nExample: `brisbane`" }, "name": { "type": "string", "description": "The name of the time zone.\n\nExample: `Eastern Australia (Brisbane)`" } }, "x-ds-definition-name": "TimeZone", "description": "Contains information about a time zone.", "x-ms-summary": "Contains information about a time zone." }, "TransactionSide": { "type": "object", "properties": { "transactionSideId": { "type": "string", "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`" }, "name": { "type": "string", "description": "The name of the transaction side. Valid values are:\n\n- `List Side`\n- `Buy Side`\n- `List & Buy Side`\n- `Refinance`\n" } }, "x-ds-definition-name": "TransactionSide", "description": "Contains information about a real estate transaction side.", "x-ms-summary": "Contains information about a real estate transaction side." }, "User": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "description": "The ID of the user." }, "email": { "type": "string", "description": "The user's email address." }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "isLockedOut": { "type": "boolean", "description": "When **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." }, "status": { "type": "string", "description": "The user's status. This property is read-only. Possible values are:\n\n- `Active`: The user is active.\n- `Pending`: The user has been invited but has not yet accepted the invitation." }, "accessLevel": { "enum": [ "Contributor", "Office", "Region", "Company", "Admin" ], "type": "string", "description": "The user's level of access to the account. This property determines what the user can see in the system.\n\nIn 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.\n\nValid values are:\n\n- `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.\n- `Region`: The user has access to rooms and, if they have permission to manage users, they have access to users across their regions.\n- `Office`: The user has access to rooms and, if they have permission to manage users, they have access to users across their offices.\n- `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.\n\n**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." }, "defaultOfficeId": { "format": "int32", "type": "integer", "description": "The ID of the user's default office." }, "titleId": { "format": "int32", "type": "integer", "description": "This field is deprecated in Rooms Version 6." }, "roleId": { "format": "int32", "type": "integer", "description": "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." }, "profileImageUrl": { "type": "string", "description": "The URL for the user's profile image." }, "offices": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "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": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "An array of region IDs for the regions in which a user with the `Region accessLevel` has been granted the ability to participate." }, "permissions": { "$ref": "#/definitions/ClassicManagerPermissions", "description": "This object is deprecated in Rooms Version 6." } }, "x-ds-definition-name": "User", "description": "Contains details about a user.", "x-ms-summary": "Contains details about a user." }, "UserForUpdate": { "required": [ "defaultOfficeId" ], "type": "object", "properties": { "defaultOfficeId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the user's default office." } }, "x-ds-definition-name": "UserForUpdate", "description": "This request object contains the information to use to update a user's default office. ", "x-ms-summary": "This request object contains the information to use to update a user's default office. " }, "UserSummary": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user." }, "email": { "type": "string", "readOnly": true, "description": "The user's email address." }, "firstName": { "type": "string", "readOnly": true, "description": "The user's first name." }, "lastName": { "type": "string", "readOnly": true, "description": "The user's last name." }, "isLockedOut": { "type": "boolean", "readOnly": true, "description": "When **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." }, "status": { "type": "string", "readOnly": true, "description": "The user's status. Possible values are:\n\n- `Active`\n- `Pending`" }, "accessLevel": { "enum": [ "Contributor", "Office", "Region", "Company", "Admin" ], "type": "string", "description": "The user's level of access to the account. This property determines what the user can see in the system.\n\nIn 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.\n\nValid values are:\n\n- `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.\n- `Region`: The user has access to rooms and, if they have permission to manage users, they have access to users across their regions.\n- `Office`: The user has access to rooms and, if they have permission to manage users, they have access to users across their offices.\n- `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.\n\n**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." }, "defaultOfficeId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the user's default office." }, "titleId": { "format": "int32", "type": "integer", "readOnly": true, "description": "This field is deprecated in Rooms Version 6." }, "roleId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization." }, "profileImageUrl": { "type": "string", "readOnly": true, "description": "The URL for the user's profile image." } }, "x-ds-definition-name": "UserSummary", "description": "Contains details about a user.", "x-ms-summary": "Contains details about a user." }, "UserSummaryList": { "type": "object", "properties": { "userSummaries": { "type": "array", "items": { "$ref": "#/definitions/UserSummary" }, "description": "A list of users." }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "UserSummaryList", "description": "Contains a list of users.", "x-ms-summary": "Contains a list of users." }, "UserToInvite": { "required": [ "accessLevel", "defaultOfficeId", "email", "eSignPermissionProfileId", "firstName", "lastName", "roleId" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "(Required) The user's first name." }, "lastName": { "type": "string", "description": "(Required) The user's last name." }, "email": { "type": "string", "description": "(Required) The user's email address." }, "roleId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the company role assigned to the user.\n\nYou can assign external roles to users who are not part of your organization.\n" }, "accessLevel": { "enum": [ "Contributor", "Office", "Region", "Company", "Admin" ], "type": "string", "description": "(Required) The user's level of access to the account. This property determines what the user can see in the system.\n\nIn 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.\n\nValid values are:\n\n- `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.\n- `Region`: The user has access to rooms and, and if they have permission to manage users, they have access to users across their regions.\n- `Office`: The user has access to rooms, and if they have permission to manage users, they have access to users across their regions.\n- `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.\n\n**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." }, "defaultOfficeId": { "format": "int32", "type": "integer", "description": "(Required) The ID of the user's default office." }, "regions": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "An array of region IDs for the regions in which a user with the `Region accessLevel` has been granted the ability to participate. If the value for `accessLevel` is `Region`, this property is required." }, "offices": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "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. If the value for `accessLevel` is `Office`, this property is required." }, "subscribeToRoomsActivityNotifications": { "default": true, "type": "boolean", "description": "" }, "eSignPermissionProfileId": { "type": "string", "description": "(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." }, "redirectUrl": { "format": "uri", "type": "string", "description": "URL to redirect to after inviting." } }, "x-ds-definition-name": "UserToInvite", "description": "This request object contains information about the user that you are inviting.", "x-ms-summary": "This request object contains information about the user that you are inviting." }, "Accounts": { "type": "object", "properties": { "companyId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the company." }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "companyVersion": { "enum": [ "v5", "v6" ], "type": "string", "description": "The version of Rooms that the company uses. This property is read-only. Possible values are:\n\n- `v6`: Rooms Version 6." }, "docuSignAccountGuid": { "type": "string", "readOnly": true, "description": "The globally-unique identifier (GUID) for the DocuSign Rooms account." }, "defaultFieldSetId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the company's default field set. A field set is a set of data fields and the information about those data fields that the system uses to configure rooms. It corresponds to the **Admin > Company > Room Details** area in the console." }, "requireOfficeLibraryAssignments": { "type": "boolean", "readOnly": true, "description": "" } }, "x-ds-definition-name": "AccountSummary", "description": "Information about accounts.", "x-ds-category": "Accounts", "x-ds-order": "10", "x-ms-summary": "Information about accounts." }, "Documents": { "required": [ "base64Contents", "name" ], "type": "object", "properties": { "documentId": { "format": "int32", "type": "integer", "description": "The ID of the document." }, "name": { "type": "string", "description": "The name of the document." }, "roomId": { "format": "int32", "type": "integer", "description": "The ID of the room the document belongs to." }, "ownerId": { "format": "int32", "type": "integer", "description": "The ID of the user who owns the document." }, "size": { "format": "int64", "type": "integer", "description": "The size of the document in bytes. This is the number of bytes in the _decoded_ document, not the size of `base64Contents`." }, "folderId": { "format": "int32", "type": "integer", "description": "The ID of the folder the document is in." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the document was created. \n\nExample: `2019-07-25T22:18:56.95Z`" }, "isSigned": { "type": "boolean", "description": "**True** if the document is signed." }, "contentType": { "type": "string", "description": "" }, "base64Contents": { "type": "string", "description": "In a response, when the query parameter `includeContents` is **true,** the base64-encoded contents of the document.\n\nIn a request, the base64-encoded contents of the document to add." }, "isDynamic": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "Document", "description": "Information about a document. This object is read-only when used as a response.", "x-ds-category": "Documents", "x-ds-order": "10", "x-ms-summary": "Information about a document. This object is read-only when used as a response." }, "ESignPermissionProfiles": { "type": "object", "properties": { "eSignPermissionProfileId": { "type": "string", "description": "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." }, "name": { "type": "string", "description": "The name of the eSignature permission profile." }, "settings": { "$ref": "#/definitions/ESignAccountRoleSettings", "description": "The settings associated with the eSignature permission profile." } }, "x-ds-definition-name": "ESignPermissionProfile", "description": "When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time.", "x-ds-category": "ESignPermissionProfiles", "x-ds-order": "10", "x-ms-summary": "When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time." }, "Fields": { "type": "object", "properties": { "fieldId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the field.\n\nExample: `10318d28-xxxx-xxxx-xxxx-d3df664f602c`\n" }, "fieldDefinitionId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the DocuSign field definition from which this field derives. When an Admin user configures a field set by using the API, this is the ID that they use to add this field definition to the field set. The original field definition associated with this ID contains more information about the field, such as the default title, default API name, and configurations such as the maximum length or the maximum value allowed." }, "title": { "type": "string", "readOnly": true, "description": "" }, "apiName": { "type": "string", "readOnly": true, "description": "The name that the Rooms API uses for the field. \n\nExample: `companyContactName`\n\n**Note:** When you create a new room, you use the `apiName` values for fields to specify the details that you want to appear on the room's **Details** tab." }, "type": { "type": "string", "readOnly": true, "description": "" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/Field" }, "readOnly": true, "description": "An array of fields." }, "configuration": { "$ref": "#/definitions/FieldConfiguration", "description": "Contains information about how the field is configured, such as the maximum length." }, "customData": { "$ref": "#/definitions/CustomData", "description": "" } }, "x-ds-definition-name": "Field", "description": "The fields resource provides a method that enables you to retrieve a specific field set. This is a set of fields that can appear on a room's **Details** tab.", "x-ds-category": "Fields", "x-ds-order": "10", "x-ms-summary": "The fields resource provides a method that enables you to retrieve a specific field set. This is a set of fields that can appear on a room's **Details** tab." }, "ExternalFormFillSessions": { "type": "object", "properties": { "url": { "format": "uri", "type": "string", "description": "" } }, "x-ds-definition-name": "ExternalFormFillSession", "description": "This resource provides a method that returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body.", "x-ds-category": "Forms", "x-ds-order": "10", "x-ms-summary": "This resource provides a method that returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body." }, "FormGroups": { "type": "object", "properties": { "formGroupId": { "type": "string", "readOnly": true, "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "formCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The number of forms in the form library. \n\nExample: `50`" } }, "x-ds-definition-name": "FormGroupSummary", "description": "The `FormGroups` resource enables you to create and manage custom groups of association forms.", "x-ds-category": "Forms", "x-ds-order": "10", "x-ms-summary": "The `FormGroups` resource enables you to create and manage custom groups of association forms." }, "FormLibraries": { "type": "object", "properties": { "formsLibraryId": { "format": "uuid", "type": "string", "readOnly": true, "description": "The ID of the form library.\n\nExample: `402c6e2f-xxxx-xxxx-xxxx-ff3f249f6da9`\n" }, "name": { "type": "string", "readOnly": true, "description": "The name of the office." }, "formCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The number of forms in the form library. \n\nExample: `50`" } }, "x-ds-definition-name": "FormLibrarySummary", "description": "The `FormLibraries` resource enables you to access standard real estate industry association forms and add them to rooms. ", "x-ds-category": "Forms", "x-ds-order": "10", "x-ms-summary": "The `FormLibraries` resource enables you to access standard real estate industry association forms and add them to rooms. " }, "ClosingStatuses": { "type": "object", "properties": { "closingStatusId": { "type": "string", "description": "The ID of the closing status.\n\nExample: `exp`" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "ClosingStatus", "description": "This resource provides a method that enables you retrieve a list of closing statuses, or valid reasons for closing a room.\n", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "This resource provides a method that enables you retrieve a list of closing statuses, or valid reasons for closing a room.\n" }, "ContactSides": { "type": "object", "properties": { "contactSideId": { "type": "string", "description": "The ID of the contact side.\n\nExample: `L`" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "ContactSide", "description": "The `ContactSides` resource provides a method that enables you to retrieve a list of valid values for transaction contact sides.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `ContactSides` resource provides a method that enables you to retrieve a list of valid values for transaction contact sides." }, "Countries": { "type": "object", "properties": { "countryId": { "type": "string", "description": "The two-letter country code of the office address (for example, \"UK\" for United Kingdom)." }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "Country", "description": "The `Countries` resource provide a method that enables you to retrieve a list of countries in which you can create an office.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `Countries` resource provide a method that enables you to retrieve a list of countries in which you can create an office." }, "Currencies": { "type": "object", "properties": { "currencyId": { "type": "string", "description": "The three-letter code for the currency.\n\nExample: `CAD`" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "Currency", "description": "The `Currencies` method provides a resource that enables you to retrieve a list currencies that you can use for listing, offer, and loan amounts.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `Currencies` method provides a resource that enables you to retrieve a list currencies that you can use for listing, offer, and loan amounts." }, "FinancingTypes": { "type": "object", "properties": { "financingTypeId": { "type": "string", "description": "The ID of the financing type.\n\nExample: `conv` (for `Conventional`)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "FinancingType", "description": "This resource provides a method that enables you to retrieve a list of financing types.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "This resource provides a method that enables you to retrieve a list of financing types." }, "OriginsOfLeads": { "type": "object", "properties": { "originOfLeadId": { "type": "string", "description": "The ID of the origin of lead.\n\nExample: `tru` (for `Trulia`)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "OriginOfLead", "description": "The `OriginsOfLeads` resource enables you to get a list of origins of leads (such as Trulia or Zillow) that you can specify for rooms.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `OriginsOfLeads` resource enables you to get a list of origins of leads (such as Trulia or Zillow) that you can specify for rooms." }, "PropertyTypes": { "type": "object", "properties": { "propertyTypeId": { "type": "string", "description": "The ID of the property type.\n\nExample: `resd` (for `Residential Detached`)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "PropertyType", "description": "The `OriginsOfLeads` resource enables you to get a list of property types (such as ????) that you can specify for rooms.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `OriginsOfLeads` resource enables you to get a list of property types (such as ????) that you can specify for rooms." }, "RoomContactTypes": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the room contact type.\n\nExample: `lisagent` (for `Listing Agent`)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "RoomContactType", "description": "The `RoomContactTypes` resource provides a method that enables you to retrieve a list of room contact types, such as Buyer, Seller, and Listing Agent.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `RoomContactTypes` resource provides a method that enables you to retrieve a list of room contact types, such as Buyer, Seller, and Listing Agent." }, "SellerDecisionTypes": { "type": "object", "properties": { "sellerDecisionTypeId": { "type": "string", "description": "The ID of the seller decision type.\n\nExample: `appr` (for `Approved`)" }, "name": { "type": "string", "description": "The name of the seller decision type." } }, "x-ds-definition-name": "SellerDecisionType", "description": "Contains information about a seller decision type.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "Contains information about a seller decision type." }, "SpecialCircumstanceTypes": { "type": "object", "properties": { "specialCircumstanceTypeId": { "type": "string", "description": "The ID of the special circumstance type.\n\nExample: `ss` (for `Short Sale`)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "SpecialCircumstanceType", "description": "The `SpecialCircumstanceTypes` resource provides a method that enables you to retrieve a list of special circumstance types, such as `Short Sale` and `Foreclosure`. These are the values that you can select for the **Special circumstances** field that appears on the **Room Details** page.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `SpecialCircumstanceTypes` resource provides a method that enables you to retrieve a list of special circumstance types, such as `Short Sale` and `Foreclosure`. These are the values that you can select for the **Special circumstances** field that appears on the **Room Details** page." }, "States": { "type": "object", "properties": { "stateId": { "type": "string", "description": "A concatenation of the two-letter country code with the state/province/region of the office address.\n\nExample: `US-OH` (for Ohio)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "State", "description": "The `States` resource provides a method that enables you to retrieve a list of states and state IDs that the Rooms API uses.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `States` resource provides a method that enables you to retrieve a list of states and state IDs that the Rooms API uses." }, "TaskDateTypes": { "type": "object", "properties": { "taskDateTypeId": { "type": "string", "description": "The ID of the task date type.\n\nExample: `tdd` (for `Task Due Date`)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "TaskDateType", "description": "This resource provides a method that returns a list of date types that you can use with tasks, such as `Actual Close Date` and `Task Due Date`.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "This resource provides a method that returns a list of date types that you can use with tasks, such as `Actual Close Date` and `Task Due Date`." }, "TaskResponsibilityTypes": { "type": "object", "properties": { "taskResponsibilityTypeId": { "type": "string", "description": "The ID of the task responsibility type." }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "TaskResponsibilityType", "description": "The `TaskResponsibilityTypes` resource enables you to return a list of responsibility types that you can assign to users when you add them to a task. ", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `TaskResponsibilityTypes` resource enables you to return a list of responsibility types that you can assign to users when you add them to a task. " }, "TaskStatuses": { "type": "object", "properties": { "taskStatusId": { "type": "string", "description": "" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "TaskStatus", "description": "", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "" }, "TimeZones": { "type": "object", "properties": { "timeZoneId": { "type": "string", "description": "The ID of the time zone for the office address.\n\nExample: `eastern` (for the Eastern US Time Zone)" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "TimeZone", "description": "The `TimeZones` resource enables you to list the time zones that you can assign to an office.", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `TimeZones` resource enables you to list the time zones that you can assign to an office." }, "TransactionSides": { "type": "object", "properties": { "transactionSideId": { "type": "string", "description": "The ID of the transaction side. Valid values are:\n\n- `buy`\n- `sell`\n- `listbuy`\n- `refi`" }, "name": { "type": "string", "description": "The name of the office." } }, "x-ds-definition-name": "TransactionSide", "description": "The `TransactionSides` resource provides a method that enables you to list possible real estate transaction sides. \n", "x-ds-category": "GlobalResources", "x-ds-order": "10", "x-ms-summary": "The `TransactionSides` resource provides a method that enables you to list possible real estate transaction sides. \n" }, "Offices": { "required": [ "name" ], "type": "object", "properties": { "officeId": { "format": "int32", "type": "integer", "description": "The ID of the office. This is the ID that the system generated when you created the office." }, "name": { "type": "string", "description": "The name of the office." }, "regionId": { "format": "int32", "type": "integer", "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "address1": { "type": "string", "description": "First line of the office street address." }, "address2": { "type": "string", "description": "Second line of the office street address." }, "city": { "type": "string", "description": "City name or metropolitan area of the office address." }, "stateId": { "type": "string", "description": "A concatenation of the two-letter country code with the state/province/region of the office address.\n\nExample: `US-OH` (for Ohio)" }, "postalCode": { "type": "string", "description": "Postal code or ZIP code of the office address." }, "countryId": { "type": "string", "description": "The two-letter country code of the office address (for example, \"UK\" for United Kingdom)." }, "timeZoneId": { "type": "string", "description": "The ID of the time zone for the office address.\n\nExample: `eastern` (for the Eastern US Time Zone)" }, "phone": { "type": "string", "description": "Phone number of the office." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the office was created.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n**Note:** This value is read-only." } }, "x-ds-definition-name": "Office", "description": "Object that contains information about an office in the Rooms account.", "x-ds-category": "Offices", "x-ds-order": "10", "x-ms-summary": "Object that contains information about an office in the Rooms account." }, "Regions": { "required": [ "name" ], "type": "object", "properties": { "regionId": { "format": "int32", "type": "integer", "description": "The ID of the region. This is the ID that the system generated when you created the region." }, "name": { "type": "string", "description": "String that specifies the region name." }, "createdDate": { "format": "date-time", "type": "string", "description": "UTC datetime that the region was created (for example \"2019-06-27T19:32:46.943\"). Note that the service assigns this value, so it is read-only." } }, "x-ds-definition-name": "Region", "description": "", "x-ds-category": "Regions", "x-ds-order": "10", "x-ms-summary": "" }, "Roles": { "type": "object", "properties": { "roleId": { "format": "int32", "type": "integer", "description": "In Rooms v6, this is the ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization.\n\n**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." }, "legacyRoleId": { "type": "string", "description": "This field is deprecated in Rooms Version 6." }, "name": { "type": "string", "description": "The name of the role. \n\nExamples: \n\n- `Agent`\n- `Default Admin`" }, "isDefaultForAdmin": { "type": "boolean", "description": "When **true,** the role is the default for account administrators." }, "isExternal": { "type": "boolean", "description": "When **true,** the role is an external role. You assign external roles to people from outside your company when you invite them into a room." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the role was created." }, "isAssigned": { "type": "boolean", "description": "When **true,** indicates that this role is currently assigned to a user." }, "permissions": { "$ref": "#/definitions/Permissions", "description": "This object is deprecated in Rooms Version 6." } }, "x-ds-definition-name": "Role", "description": "This object contains information about a role.", "x-ds-category": "Roles", "x-ds-order": "10", "x-ms-summary": "This object contains information about a role." }, "Rooms": { "type": "object", "properties": { "roomId": { "format": "int32", "type": "integer", "description": "The ID of the room." }, "companyId": { "format": "int32", "type": "integer", "description": "The ID of the company." }, "name": { "type": "string", "description": "The name of the room.\n\nMaximum Length: 100 characters." }, "officeId": { "format": "int32", "type": "integer", "description": "The ID of the office. This is the ID that the system generated when you created the office." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" }, "submittedForReviewDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the room was submitted for review. This is when a member with a role for which the **Submit rooms for review** permission is set to **true** submitted the room to a member with a role for which the **Review and close rooms** permission is set to **true.**" }, "closedDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the room was closed." }, "rejectedDate": { "format": "date-time", "type": "string", "description": "The date on which the reviewer rejected the room. For example, a reviewer might reject closing a room if documentation is missing or the details are inaccurate." }, "createdByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who created the room." }, "roomOwnerIds": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "" }, "rejectedByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who rejected the room." }, "closedStatusId": { "type": "string", "description": "The reason why a room was closed. Possible values are:\n\n- `sold`: Property sold.\n- `dup`: Duplicate room.\n- `escrcncl`: Escrow canceled.\n- `inspctn`: Inspection issues.\n- `exp`: Listing expired.\n- `lostbuy`: Buyer withdrew.\n- `list`: Listing withdrawn. \n- `newlist`: New listing.\n- `offrrjct`: Offer not accepted.\n- `pend`: Pending. An agent might use this status to temporarily hide a room from their Active rooms view if they are blocked on a task. When they are ready to reopen the room, they can quickly find it by filtering for rooms in `pending` status.\n- `lstcanc`: Listing canceled. \n- `lstleave`: Listing released.\n- `sellwtdw`: Seller withdrew.\n- `nofin`: Buyer unable to finance.\n- `disciss`: Property disclosure issue.\n- `appiss`: Appraisal issues.\n- `mtgiss`: Mortgage issues. Use when details about why the buyer wasn't able to obtain financing are unknown.\n- `zoniss`: Zoning issues.\n- `attiss`: Attorney review issues.\n- `proplsd`: Property leased. Use for the list side of the transaction.\n- `tenlease`: Tenant signed lease. Use when an agent helps renters find a to lease. " }, "fieldDataLastUpdatedDate": { "format": "date-time", "type": "string", "description": "" }, "fieldData": { "$ref": "#/definitions/FieldData", "description": "The field data associated with a room.\nSee [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/)." } }, "x-ds-definition-name": "Room", "description": "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.", "x-ds-category": "Rooms", "x-ds-order": "10", "x-ms-summary": "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." }, "RoomFolders": { "type": "object", "properties": { "roomFolderId": { "format": "int32", "type": "integer", "description": "Filters results by `folderId`. If this property is not set, no filtering is applied." }, "name": { "type": "string", "description": "The name of the office." }, "isDefault": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "RoomFolder", "description": "", "x-ds-category": "Rooms", "x-ds-order": "10", "x-ms-summary": "" }, "RoomTemplates": { "type": "object", "properties": { "roomTemplateId": { "format": "int32", "type": "integer", "readOnly": true, "description": "The ID of the room template." }, "name": { "type": "string", "readOnly": true, "description": "The name of the room template." }, "taskTemplateCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "The total number of task templates that the room template uses." } }, "x-ds-definition-name": "RoomTemplate", "description": "The room template resources provides a method that enables you to retrieve the room templates associated with an account.", "x-ds-category": "RoomTemplates", "x-ds-order": "10", "x-ms-summary": "The room template resources provides a method that enables you to retrieve the room templates associated with an account." }, "TaskLists": { "type": "object", "properties": { "taskListId": { "format": "int32", "type": "integer", "description": "The ID of the task list." }, "name": { "type": "string", "description": "The name of the office." }, "taskListTemplateId": { "format": "int32", "type": "integer", "description": "The ID of the task list template." }, "submittedForReviewDate": { "format": "date-time", "type": "string", "description": "The UTC DateTime when the room was submitted for review. This is when a member with a role for which the **Submit rooms for review** permission is set to **true** submitted the room to a member with a role for which the **Review and close rooms** permission is set to **true.**" }, "approvalDate": { "format": "date-time", "type": "string", "description": "" }, "rejectedDate": { "format": "date-time", "type": "string", "description": "The date on which the reviewer rejected the room. For example, a reviewer might reject closing a room if documentation is missing or the details are inaccurate." }, "createdDate": { "format": "date-time", "type": "string", "description": "The UTC date and time when the item was created. This is a read-only value that the service assigns.\n\nExample: `2019-07-17T17:45:42.783Z`\n\n" }, "approvedByUserId": { "format": "int32", "type": "integer", "description": "" }, "rejectedByUserId": { "format": "int32", "type": "integer", "description": "The ID of the user who rejected the room." }, "comment": { "type": "string", "description": "" }, "tasks": { "type": "array", "items": { "$ref": "#/definitions/TaskSummary" }, "description": "A list of tasks in the task list." } }, "x-ds-definition-name": "TaskList", "description": "The `TaskLists` resource helps you keep track of the documents and activities you must complete before you can close a room.", "x-ds-category": "TaskLists", "x-ds-order": "10", "x-ms-summary": "The `TaskLists` resource helps you keep track of the documents and activities you must complete before you can close a room." }, "TaskListTemplates": { "type": "object", "properties": { "taskListTemplateId": { "format": "int32", "type": "integer", "description": "The ID of the task list template." }, "name": { "type": "string", "description": "The name of the office." }, "taskCount": { "format": "int32", "type": "integer", "description": "The total number of tasks in the task list template." }, "tasksWithDocumentsCount": { "format": "int32", "type": "integer", "description": "The number of tasks in the task list template that have documents associated with them." } }, "x-ds-definition-name": "TaskListTemplate", "description": "A task list template is a custom task list that can be added to rooms.\n", "x-ds-category": "TaskLists", "x-ds-order": "10", "x-ms-summary": "A task list template is a custom task list that can be added to rooms.\n" }, "Users": { "type": "object", "properties": { "userId": { "format": "int32", "type": "integer", "description": "The ID of the user." }, "email": { "type": "string", "description": "The user's email address." }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "isLockedOut": { "type": "boolean", "description": "When **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." }, "status": { "type": "string", "description": "Valid values are 'Active', 'Pending'" }, "accessLevel": { "enum": [ "Contributor", "Office", "Region", "Company", "Admin" ], "type": "string", "description": "The user's level of access to the account. This property determines what the user can see in the system.\n\nIn 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.\n\nValid values are:\n\n- `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.\n- `Region`: The user has access to rooms and, if they have permission to manage users, they have access to users across their regions.\n- `Office`: The user has access to rooms and, if they have permission to manage users, they have access to users across their offices.\n- `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.\n\n**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." }, "defaultOfficeId": { "format": "int32", "type": "integer", "description": "The ID of the user's default office." }, "titleId": { "format": "int32", "type": "integer", "description": "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\".\n\n**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." }, "roleId": { "format": "int32", "type": "integer", "description": "In Rooms v6, this is the ID of the company role assigned to the user.\n\nYou can assign external roles to users who aren't a part of your organization.\n\n**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." }, "profileImageUrl": { "type": "string", "description": "The URL for the user's profile image." }, "offices": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "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": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "An array of region IDs for the regions in which a user with the `Region accessLevel` has been granted the ability to participate." }, "permissions": { "$ref": "#/definitions/ClassicManagerPermissions", "description": "This object is deprecated in Rooms Version 6." } }, "x-ds-definition-name": "User", "description": "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.", "x-ds-category": "Users", "x-ds-order": "10", "x-ms-summary": "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." }, "FormProviders": { "type": "object", "properties": { "formProviderAssociations": { "type": "array", "items": { "$ref": "#/definitions/FormProviderAssociationSummary" }, "description": "" }, "resultSetSize": { "format": "int32", "type": "integer", "description": "The number of results returned in this response." }, "startPosition": { "format": "int32", "type": "integer", "description": "The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is `0`." }, "endPosition": { "format": "int32", "type": "integer", "readOnly": true, "description": "The last zero-based index position in the result set." }, "nextUri": { "type": "string", "description": "The URI for the next chunk of records based on the search request. This property is `null` for the last set of search results." }, "priorUri": { "type": "string", "description": "The URI for the previous chunk of records based on the search request. This property is `null` for the first set of search results." }, "totalRowCount": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "FormProviderAssociationsSummaryList", "description": "", "x-ds-category": "Forms", "x-ds-order": "100", "x-ms-summary": "" } }, "securityDefinitions": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"" } }, "security": [ { "Bearer": [] } ], "externalDocs": { "description": "Rooms API Reference", "url": "https://developers.docusign.com/docs/rooms-api/reference/" }, "tags": [ { "name": "FormDetails", "description": "This section shows you how to retrieve a form's details.\n\n" }, { "name": "Accounts", "description": "Information about accounts." }, { "name": "Documents", "description": "Methods to grant access, delete, and get information, including contents, to a document." }, { "name": "ESignPermissionProfiles", "description": "This resource provides a method that returns a list of the eSignature permission profiles that the current user can assign to a new member." }, { "name": "Fields", "description": "Information about field sets." }, { "name": "ExternalFormFillSessions", "description": "" }, { "name": "FormGroups", "description": "With the appropriate permissions, form administrators at your company can create form groups, or curated set of forms gathered from the association **form libraries** to which DocuSign provides access. Form groups enable agents to know which forms to add to rooms based on the type of transaction they are working on. When creating groups, administrators can make certain forms required, ensuring compliance. If you don't create groups, agents will have to choose forms they need from a list of association forms." }, { "name": "FormLibraries", "description": "" }, { "name": "ClosingStatuses", "description": "" }, { "name": "ContactSides", "description": "" }, { "name": "Countries", "description": "" }, { "name": "Currencies", "description": "" }, { "name": "FinancingTypes", "description": "" }, { "name": "OriginsOfLeads", "description": "In the console, these are the values that can appear on a room's **Details** tab in the **Origin of lead** field." }, { "name": "PropertyTypes", "description": "In the console, these are the values that can appear on a room's **Details** tab in the **Property type** field." }, { "name": "RoomContactTypes", "description": "" }, { "name": "SellerDecisionTypes", "description": "" }, { "name": "SpecialCircumstanceTypes", "description": "" }, { "name": "States", "description": "" }, { "name": "TaskDateTypes", "description": "Task date types are the options that appear in the **Due Date** drop-down list when you create a task by using the console." }, { "name": "TaskResponsibilityTypes", "description": "" }, { "name": "TaskStatuses", "description": "" }, { "name": "TimeZones", "description": "" }, { "name": "TransactionSides", "description": "" }, { "name": "Offices", "description": "The `Offices` resource enables you to create and manage offices for your company. You can also retrieve the number and type of objects that reference an office." }, { "name": "Regions", "description": "" }, { "name": "Roles", "description": "Each role is associated with specific permissions. Each new member is assigned a role when you create them, automatically granting them the permissions associated with that role.\n\nRoles use the following permission types to control the actions that users can perform:\n\n- Room\n- Room Details\n- Documents\n- Envelopes\n- Member Management\n- Company Settings\n\nRooms enables you to configure custom roles containing permissions that make sense for your company. Because each new member is assigned a role, you must set up these roles before you can invite members to join your account.\n\nPermissions for roles are tied to the `roleId` property and not yet exposed. You can learn more about these permission types and configure them in the console.\n\n### Internal and External Roles\n\nIn Rooms, a role can be either internal or external. You assign internal roles to people inside your company. You assign external roles to people outside your company when you invite them to a room.\n\nEach member inside your company has a default company role. However, they can also be assigned additional roles with different permissions on a per-room basis. Regardless of the member's default company role, what they can do in a room is entirely controlled by their role in that particular room." }, { "name": "Rooms", "description": "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." }, { "name": "RoomFolders", "description": "" }, { "name": "RoomTemplates", "description": "You can use a room template to set the transaction side and task lists for rooms. For example, a broker can create a room template for agents to use. You can enable the room template for all regions and offices, or just for specific ones. You create room templates and the task templates that room templates use in the console." }, { "name": "TaskLists", "description": "" }, { "name": "TaskListTemplates", "description": "If your administrator created room templates, those room templates may include task lists for you to use." }, { "name": "Users", "description": "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`.\n\n## Inviting a user to a room\n\nTo invite a user to a room, use the [Rooms_InviteUser](/docs/rooms-api/reference/Rooms/Rooms/InviteUser/) method. You can invite anyone to join a room by specifying their email address.\n\nYou must have the `canAddUsersToRooms` permission set to **true** to invite a user to a room.\n\n## Adding a user to a company Rooms account\n\nTo invite a user to a company account, use the [Users_inviteUser](/docs/rooms-api/reference/Users/Users/InviteUser/) method.\n\nYou must be either an account administrator (Default Admin) or another authorized user who is assigned a company role that has one of the following `userPermissions` set to **true:**\n\n- `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).\n- `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).\n\n**Note:** Before you invite users, DocuSign strongly recommends that you set up custom roles for your company. For more information, see [Roles](/docs/rooms-api/reference/Roles/Roles/)." }, { "name": "FormProviders", "description": "" } ], "x-ds-categories": [ { "name": "Accounts", "summary": "Information about accounts.", "description": "Information about accounts." }, { "name": "Documents", "summary": "Information about documents.", "description": "Information about documents." }, { "name": "ESignPermissionProfiles", "summary": "A permission profile is a standard set of user permissions that you can apply to individual users or the users in a group. This functionality makes it easier to manage permissions for a large number of users.", "description": "When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This section shows you how to retrieve a list of eSignature permission profiles that the current user can assign to a new member.\n\nYou can use the API only to retrieve and assign eSignature permission profiles. You create and modify permission profiles in the DocuSign console." }, { "name": "Fields", "summary": "This section shows you how to retrieve a specific field set. This is a set of fields that can appear on a room's **Details** tab.", "description": "Information about field sets." }, { "name": "Forms", "summary": "The Forms feature of DocuSign Rooms for Real Estate enables provides access to standard industry association forms that you can add to rooms.\n\n**Note:** Forms is not a default feature and is currently only available in Rooms for Real Estate. To request access to Forms, contact your DocuSign Account Manager.\n\n", "description": "## Form groups\n\nWith the appropriate permissions, form administrators at your company can create form groups, or curated set of forms gathered from the association **form libraries** to which DocuSign provides access. Form groups enable agents to know which forms to add to rooms based on the type of transaction they are working on. When creating groups, administrators can make certain forms required, ensuring compliance. If you don't create groups, agents will have to choose forms they need from a list of association forms.\n\n## Permissions\n\nTo manage forms, you must have the `canManageFormGroups` permission, which enables you to access the **Forms** tab in **Admin.** For all other roles, assign permissions based on how these users will be working with forms. If no form permissions are enabled for these roles, users cannot add forms to rooms.\n\nForm administrators must have the `canManageFormGroups` permission assigned to their user role. This gives them access to the **Forms** tab in **Admin.** However, you should also consider the user's access level. For example, if the user has access to specific offices, they can only administer form groups for those offices. \n" }, { "name": "GlobalResources", "summary": "The Global Resources category organizes resource that are used throughout the Rooms API. You typically use these resources when you create or update a room, region, office, or user.", "description": "This section shows you how to retrieve the following Global Resources:\n\n- Activity Types\n- Closing Statuses\n- Contact Sides\n- Countries\n- Currencies\n- Financing Types\n- Origins of Leads\n- Property Types\n- Room Contact Types\n- Seller Decision Types\n- Special Circumstances Types\n- States\n- Task Date Types\n- Task Responsibility Types\n- Time Zones\n- Transaction Sides" }, { "name": "Offices", "summary": "You can use the API to manage offices in your Rooms account.", "description": "This section shows you how to create and manage offices." }, { "name": "Regions", "summary": "You can use the API to manage regions associated with your Rooms account.", "description": "This section shows you how to create and manage regions for a Rooms account." }, { "name": "Roles", "summary": "The Roles resource enables you to easily manage user permissions. ", "description": "Each role is associated with specific permissions. Each new member is assigned a role when you create them, automatically granting them the permissions associated with that role.\n\nRoles use the following permission types to control the actions that users can perform:\n\n- Room\n- Room Details\n- Documents\n- Envelopes\n- Member Management\n- Company Settings\n\nRooms enables you to configure custom roles containing permissions that make sense for your company. Because each new member is assigned a role, you must set up these roles before you can invite members to join your account.\n\nPermissions for roles are tied to the `roleId` property and not yet exposed. You can learn more about these permission types and configure them in the web application.\n\n### Internal and External Roles\n\nIn Rooms, a role can be either internal or external. You assign internal roles to people inside your company. You assign external roles to people outside your company when you invite them to a room.\n\nEach member inside your company has a default company role. However, they can also be assigned additional roles with different permissions on a per-room basis. Regardless of the member's default company role, what they can do in a room is entirely controlled by their role in that particular room.\n" }, { "name": "Rooms", "summary": "This section shows you how to create and mange 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.", "description": "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.\n" }, { "name": "RoomTemplates", "summary": "Room templates enable your company to standardize the new rooms that users create. ", "description": "This section shows you how to retrieve room templates. You can perform additional room template tasks in the console." }, { "name": "TaskLists", "summary": "The TaskLists resource helps you keep track of the documents and activities you must complete before you can close a room.", "description": "Your administrator may also have created custom task list templates that can be added to rooms. If your administrator created room templates, those room templates may include task lists for you to use." }, { "name": "Users", "summary": "The Users resource provides methods that enable you to add, update, delete, and manage users.", "description": "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." } ] }