Rooms: AddDocumentToRoomViaFileUpload

This method uploads the contents of file as a room document for the room that you specify.

This is a multipart form request. You must include the following headers:

  • Content-Type: multipart/form-data (with a boundary)
  • Content-Disposition: form-data
  • Content-Disposition: file (with the filename)

For an example and more information, see Multipart Form Requests.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The id of the account.

Responses

CodeDescriptionReference
201

Document successfully added.

RoomDocument
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::AddDocumentToRoomViaFileUpload

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.

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.

}} />