Rooms: AddFormToRoom

Adds a form to a room.

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

Permissions

Rooms Version 5: You must be Admin to use this method.

Rooms Version 6: You must have a role for which the canAddDocumentsFromFormLibraries permission is set to true.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room to which you want to add the form.

accountIdstring

(Required) The id of the account.

Request Body

formForAdd

Responses

CodeDescriptionReference
201

The DocuSign Form was successfully added to the room

RoomDocument
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::AddFormToRoom

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

FormForAdd

Contains details about the form that you want to add.

formIdstring

(Required) The id of the form.

RoomDocument

An individual document in a room.

documentIdinteger

The id of the document.

namestring

The file name of the document.

Example: Short Sale Supplement to Marketing Agreement.pdf

ownerIdinteger

The id of the user who owns the document.

sizeinteger

The size of the document in bytes.

folderIdinteger

The id of the folder the document is in.

createdDatestring

The UTC date and time that the document was created or uploaded.

Example: 2019-07-25T22:18:56.95Z

isSignedboolean

When set to true, this property indicates that the document is signed.

docuSignFormIdstring

The id of the corresponding DocuSign form.

}} />