Skip to navigation

Split document

View as Markdown

If a destination folder is provided, the resulting documents will be stored in the account.

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Request

SplitDocumentTask object definition containing the document and on which pages to split it.
PagesstringOptional

Specification for how the document will be split. Can be ranges or individual pages. e.g. 1-3,5

MessagestringOptional

Additional explanation of the status (if any)

DownloadUrlstringOptional
The URI where the document can be downloaded, if no destination folder is provided
DestinationDocumentNamestringOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the name of the new document
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
DocumentobjectOptional
Document to split
ResultDocumentobjectOptional
The document that is created as a result of this task
DestinationFolderobjectOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the folder where the new document should be placed

Response

OK
PagesstringOptional

Specification for how the document will be split. Can be ranges or individual pages. e.g. 1-3,5

MessagestringOptional

Additional explanation of the status (if any)

DownloadUrlstringOptional
The URI where the document can be downloaded, if no destination folder is provided
DestinationDocumentNamestringOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the name of the new document
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
DocumentobjectOptional
Document to split
ResultDocumentobjectOptional
The document that is created as a result of this task
DestinationFolderobjectOptional
If the result of the asynchronous task is to be saved in a SpringCM permanent storage, this is the folder where the new document should be placed