Skip to navigation

Merge document template with XML data

View as Markdown

Submit an asynchronous task to merge a document template with XML data. User must provide either XML data, an attribute document or a content document. 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

DocumentXmlMergeTask object containing the template document and XML data or an XML data document.
DataXmlstringOptional
XML data used to populate the template document
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.
TemplateDocumentobjectOptional
Document that serves as a template to be populated with data
AttributeDocumentobjectOptional
Document in the account that contains the data used to populate the template document in its attributes
ContentDocumentobjectOptional
Document in the account that contains the XML used to populate the template document in its content
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
DataXmlstringOptional
XML data used to populate the template document
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.
TemplateDocumentobjectOptional
Document that serves as a template to be populated with data
AttributeDocumentobjectOptional
Document in the account that contains the data used to populate the template document in its attributes
ContentDocumentobjectOptional
Document in the account that contains the XML used to populate the template document in its content
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