Skip to navigation

Merge multiple documents into PDF

View as Markdown

Submit an asynchronous task to merge multiple documents into a single PDF. If no destination folder is specified, an HREF to download the document will be provided.

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

DocumentMergeTask object definition containing the list of documents to merge and optional destination folder.
DocumentsToMergelist of objectsOptional
Documents to merge
DeleteOriginalsbooleanOptional
Option to delete original documents after successful merge
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.
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
DocumentsToMergelist of objectsOptional
Documents to merge
DeleteOriginalsbooleanOptional
Option to delete original documents after successful merge
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.
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