DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Chunked Upload → Update

AI-generated

Summary

Updates the status of a chunked upload by applying the next chunk of data.

Inputs

  • authentication — Authentication method to use (OAuth2 or JWT).
  • category — DocuSign API category (e.g., envelopes, templates).
  • accountId (required) — DocuSign Account ID (GUID).
  • chunkedUploadId (required) — ID of the chunked upload to update.
  • chunkIndex (required) — Zero‑based index of the chunk being uploaded.
  • inputDataSource — Source of the chunk data (binaryProperty or base64).
  • binaryPropertyName — Name of the binary property containing the chunk data when using binaryProperty source.
  • base64Data — Base64‑encoded chunk data when using base64 source.

Output shape

object confirming successful update; may include the updated chunked upload details or be empty on success, with standard DocuSign error envelope on failure.

The response can be empty for a successful update; errors are returned as per DocuSign API.

Examples

Example 1: Update chunk index 2 of an upload using binary property data

authentication: oAuth2, category: envelopes, accountId: 12345678-90ab-cdef-1234-567890abcdef, chunkedUploadId: 87654321-1234-5678-90ab-cdef12345678, chunkIndex: 2, inputDataSource: binaryProperty, binaryPropertyName: data, base64Data: ''

Example 2: Commit the final chunk of a chunked upload

authentication: oAuth2, category: envelopes, accountId: 12345678-90ab-cdef-1234-567890abcdef, chunkedUploadId: 87654321-1234-5678-90ab-cdef12345678, chunkIndex: 0, inputDataSource: base64, base64Data: 'AQMAAA...'

Links

Discussion