Skip to navigation

DocumentGeneration Resource

View as Markdown

Document generation enables you to create reusable templates with professionally formatted documents that include personalized data. For example, you can create a boilerplate employment offer letter that is updated with job details for each candidate from an HR system .

To learn more about using these endpoints with the eSignature API, see Document generation in the eSignature concepts guide.

Methods supported

MethodDescription
createArchiveMetadataEnvelopesPOST /restapi/v2.1/accounts/{accountId}/envelopes/archive_metadata
Add metadata in the form of GenAndSend to existing envelopes in docusign.
createGenAndArchiveEnvelopesPOST /restapi/v2.1/accounts/{accountId}/envelopes/generate_and_archive
Generates the document using DocuSign Spring CM template then returns the html content of the document.
createGenAndConvertEnvelopesPOST /restapi/v2.1/accounts/{accountId}/envelopes/generate_and_convert
Generates the document using DocuSign Spring CM template then returns the content of the document based on the return document type.
createGenAndConvertMultiEnvelopesPOST /restapi/v2.1/accounts/{accountId}/envelopes/generate_and_convert_multi
Generates multiple document using DocuSign Spring CM template then returns the content of the document based on the return document type.
createGenAndSendEnvelopesPOST /restapi/v2.1/accounts/{accountId}/envelopes/generate_and_send
Generates the documents for an envelope using DocuSign Spring CM then creates the envelope.
createLinkMetadataEnvelopesPOST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/archive_metadata
Add metadata in the form of GenAndSend to existing envelopes in docusign.
getEnvelopeDocGenFormFieldsGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields
Returns sender fields for an envelope.
updateEnvelopeDocGenFormFieldsPUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields
Updates sender fields for an envelope.

DocumentGeneration properties

PropertyTypeDescription
docGenFormFieldsarray
errorDetailserrorDetailsThis object describes errors that occur. It is only valid for responses and ignored in requests.