{"api":"esign_rest","category":"reference"}

Templates Category

Use the Templates category to manage your account's templates.

You can:

  • Create, list, get, update, and delete templates.
  • Manage templates' notification and group sharing settings.
  • Fetch and rotate pages from a document used by a template.

Templates can be created programmatically or can be created via the DocuSign web interface and then used by your application.

TemplateDocumentTabs

MethodDescription
getByPage
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs

Returns tabs on the specified page.

get
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

Returns tabs on the document.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

create
POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

Create Template Document Tabs

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

TemplateRecipients

Template recipients

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients

Gets recipient information from a template.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients

Updates recipients in a template.

create
POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients

Adds tabs for a recipient.

deleteList
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients

Deletes recipients from a template.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}

Deletes the specified recipient file from a template.

createTemplateRecipientPreview
POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview

Creates a template recipient preview.

TemplateBulkRecipients

Template bulk recipients

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Gets the bulk recipient file from a template.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Adds or replaces the bulk recipients list in a template.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Deletes the bulk recipient list on a template.

TemplateCustomFields

A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.

There are two types of custom fields:

  • text: Enables the sender to enter the value for the field.
  • list: Enables the sender to select the value of the field from a predetermined list.

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Gets the custom document fields from a template.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Updates envelope custom fields in a template.

create
POST /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Creates custom document fields in an existing template document.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Deletes envelope custom fields in a template.

TemplateDocumentFields

Template document fields

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

Gets the custom document fields for a an existing template document.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

Updates existing custom document fields in an existing template document.

create
POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

Creates custom document fields in an existing template document.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

Deletes custom document fields from an existing template document.

TemplateDocuments

Template documents

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents

Gets a list of documents associated with a template.

updateList
PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents

Adds documents to a template document.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents

Deletes documents from a template.

get
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}

Gets PDF documents from a template.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}

Updates a template document.

TemplateLocks

This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.

MethodDescription
get
GET /v2.1/accounts/{accountId}/templates/{templateId}/lock

Gets template lock information.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/lock

Updates a template lock.

create
POST /v2.1/accounts/{accountId}/templates/{templateId}/lock

Locks a template.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/lock

Deletes a template lock.

Templates

Template management

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates

Gets template definitions.

create
POST /v2.1/accounts/{accountId}/templates

Creates a template.

get
GET /v2.1/accounts/{accountId}/templates/{templateId}

Gets a specific template associated with a specified account.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}

Updates an existing template.

updateGroupShare
PUT /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}

Shares a template with a group.

deleteGroupShare
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}

Removes a member group's sharing permissions for a template.

getPageImages
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages

Returns document page image(s) based on input.

deleteDocumentPage
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}

Deletes a page from a document in an template.

getDocumentPageImage
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image

Gets a page image from a template for display.

rotateDocumentPage
PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image

Rotates page image from a template for display.

getNotificationSettings
GET /v2.1/accounts/{accountId}/templates/{templateId}/notification

Gets template notification information.

updateNotificationSettings
PUT /v2.1/accounts/{accountId}/templates/{templateId}/notification

Updates the notification structure for an existing template.

TemplateRecipientTabs

Template tabs

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Gets the tabs information for a signer or sign-in-person recipient in a template.

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Updates the tabs for a recipient.

create
POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Adds tabs for a recipient.

delete
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Deletes the tabs associated with a recipient in a template.

TemplateViews

A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).

MethodDescription
createEdit
POST /v2.1/accounts/{accountId}/templates/{templateId}/views/edit

Gets a URL for a template edit view

TemplateDocumentVisibility

Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.

Note: Before you use Document Visibility, you should be aware of the following information:

  • Document Visibility must be enabled for your account by your DocuSign administrator.
  • A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document.
  • When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.
  • Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.

The Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see Use Document Visibility to Control Recipient Access.

MethodDescription
get
GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility

Returns document visibility for a template recipient

update
PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility

Updates document visibility for a template recipient

updateList
PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility

Updates document visibility for template recipients

TemplateDocumentResponsiveHtmlPreview

MethodDescription
create
POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview

TemplateResponsiveHtmlPreview

MethodDescription
create
POST /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview

TemplateDocumentHtmlDefinitions

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions

TemplateHtmlDefinitions

MethodDescription
list
GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions

}} />