Chunked Uploads

Commit a chunked upload

PUT
/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.

If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.

Note: After you commit a chunked upload, it no longer accepts additional parts.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

chunkedUploadId*string

(Required) The ID of the chunked upload to commit.

Query Parameters

action?string

(Required) You must use this query parameter with the value commit, which affirms the request to validate and prepare the chunked upload for use with other API calls.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/chunked_uploads/string"
{  "checksum": "string",  "chunkedUploadId": "string",  "chunkedUploadParts": [    {      "sequence": "string",      "size": "string"    }  ],  "chunkedUploadUri": "string",  "committed": "string",  "expirationDateTime": "string",  "maxChunkedUploadParts": "string",  "maxTotalSize": "string",  "totalSize": "string"}

Deletes a chunked upload DELETE

Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.

Add a chunk to an existing chunked upload PUT

Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, Docusign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, Docusign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to Docusign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` **Note:** You cannot replace a part that Docusign has already received, or add parts to a chunked upload that is already successfully committed.