Templates Resource

The Template resource provides methods that allow you to manipulate and monitor templates.

Once you have authenticated the user you can use the Templates: createTemplate method to create an template. You can call the TemplateDocuments: update or TemplateDocuments: updateList method to add additional documents.

If you have an template that you have previously saved, you can modify the subject and message, send it, void it, or purge it from the DocuSign system using the Template: update.

In addition to receiving notifications you can monitor the status of the templates using the following methods:

  • Template: getTemplate - To get the status of a template.
  • Template: listStatus - To get the template status for a set of templates.
  • Template: listStatusChanges - To get status changes information for one or more templates.

If you need to delete a page from a document in an template, use the Template: deleteDocumentPage method.

The resource also includes a number of methods that allow you to retrieve and set the initials and signature for certain types of recipients on the document.

Methods

Method Description
create POST /v2/accounts/{accountId}/templates

Creates a template.

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

Deletes a page from a document in an template.

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

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

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

Gets a list of templates for a specified account.

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

Gets a page image from a template for display.

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

Gets template notification information.

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

Returns document page image(s) based on input.

list GET /v2/accounts/{accountId}/templates

Gets the definition of a template.

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

Rotates page image from a template for display.

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

Updates an existing template.

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

Shares a template with a group

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

Updates the notification structure for an existing template.