Skip to navigation

EnvelopeTemplates Resource

View as Markdown

The EnvelopeTemplates resource provides methods that enable you to add and delete templates on envelopes and documents. You can apply a single template or multiple templates to an envelope. When applying multiple templates, use composite templates to combine documents, recipients, roles, and tabs from multiple templates.

Methods supported

MethodDescription
applyPOST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates
Adds templates to an envelope.
applyToDocumentPOST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
Adds templates to a document in an envelope.
deleteDEL /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}
Deletes a template from a document in an existing envelope.
listGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates
Gets templates used in an envelope.
listByDocumentGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
Gets the templates associated with a document in an existing envelope.

EnvelopeTemplates properties

PropertyTypeDescription
templatesarrayAn array of templateSummary objects that contain information about templates.