DOdocusign
ChunkedUploads

Initiate a new chunked upload.

This method initiates a new chunked upload with the first part of the content.

post/v2.1/accounts/{accountId}/chunked_uploads

Request

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Request body multipart/form-data

chunkedUploadIdstring

The ID of the chunked upload.

Note: This property is ignored in requests, and overridden with an auto-generated value in responses.

datastring

A base64-encoded representation of the content that is used to upload the file.

Maximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.

Response

Successful response.

checksumstring

A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.

chunkedUploadIdstring

The ID of the chunked upload.

chunkedUploadUristring

The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests.

committedstring

When true, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests.

expirationDateTimestring

The UTC time at which the chunked upload expires and is no longer addressable.

Note: You must fully upload and use a chunked upload within 20 minutes of initializing it.

maxChunkedUploadPartsstring

The maximum number of parts allowed for a chunked upload. This value is configurable per Docusign environment, account, or integrator. The default value is 128. The maximum possible value is 256.

maxTotalSizestring

The maximum total size allowed for a chunked upload. This value is configured per Docusign environment, account, or integrator. The default value is 50 MB.

totalSizestring

The total size of the parts of the chunked upload.

Note: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.

Changes

No recorded changes to this operation across all 39 revisions of this API.