docusign.chunked-uploads.put-chunked-uploads

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.

Commit a chunked upload.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	(Required) The external account number (int) or account ID GUID.
chunkeduploadid	string	Yes	—	(Required) The ID of the chunked upload to commit.
action	string	No	—	(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.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	(Required) The external account number (int) or account ID GUID.
chunkeduploadid	string	Yes	—	(Required) The ID of the chunked upload to commit.
action	string	No	—	(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.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/chunked_uploads/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/chunked_uploads/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.chunked-uploads.put-chunked-uploads",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "chunkeduploadid": "value"
  }
}