DocuSign: Initiate a new chunked upload
DocuSign esignature.esignatureChunkedUploadsPostChunkedUploads: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_chunkeduploads_postchunkeduploads
Provider route: POST /restapi/v2.1/accounts/{accountId}/chunked_uploads. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureChunkedUploadsPostChunkedUploads"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureChunkedUploadsPostChunkedUploads(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_chunked_uploads_post_chunked_uploads(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
body | Model | Optional | Expand Initiate a new chunked upload — request body — body |
Referenced models: Initiate a new chunked upload — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Commit a chunked upload — response body |
Referenced models: Commit a chunked upload — response body
Schemas
Section titled “Schemas”Commit a chunked upload — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This response object is returned after you upload a chunked upload. |
checksum | string | Optional | 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. |
chunkedUploadId | string | Optional | The ID of the chunked upload. |
chunkedUploadParts | array | Optional | A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload. |
chunkedUploadParts[] | Model | Each item | Expand Commit a chunked upload — response body — chunked Upload Parts item |
chunkedUploadUri | string | Optional | The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. |
committed | string | Optional | 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. |
expirationDateTime | string | Optional | 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. |
maxChunkedUploadParts | string | Optional | 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. |
maxTotalSize | string | Optional | 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. |
totalSize | string | Optional | 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. |
Referenced models: Commit a chunked upload — response body — chunked Upload Parts item
Initiate a new chunked upload — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This is the request object for uploading a chunked upload. |
chunkedUploadId | string | Optional | The ID of the chunked upload. **Note:** This property is ignored in requests, and overridden with an auto-generated value in responses. |
data | string | Optional | 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. |
Commit a chunked upload — response body — chunked Upload Parts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object that contains information about the chunked upload part. |
sequence | string | Optional | The order of the part in the chunked upload. |
size | string | Optional | The size of the part in bytes. Docusign recommends that a chunked upload part is no larger than a few MB in size. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_chunkeduploads_postchunkeduploads. Catalog operation: esignature:ChunkedUploads_PostChunkedUploads. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.