{"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/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs

Returns tabs on the specified page.

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

Returns tabs on the document.

TemplateRecipients

Template recipients

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

Gets recipient information from a template.

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

Updates recipients in a template.

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

Adds tabs for a recipient.

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

Deletes recipients from a template.

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

Deletes the specified recipient file from a template.

TemplateBulkRecipients

Template bulk recipients

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

Gets the bulk recipient file from a template.

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

Adds or replaces the bulk recipients list in a template.

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

Deletes the bulk recipient list on a template.

TemplateCustomFields

Template custom fields

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

Gets the custom document fields from a template.

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

Updates envelope custom fields in a template.

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

Creates custom document fields in an existing template document.

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

Deletes envelope custom fields in a template.

TemplateDocumentFields

Template document fields

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

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

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

Updates existing custom document fields in an existing template document.

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

Creates custom document fields in an existing template document.

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

Deletes custom document fields from an existing template document.

TemplateDocuments

Template documents

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

Gets a list of documents associated with a template.

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

Adds documents to a template document.

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

Deletes documents from a template.

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

Gets PDF documents from a template.

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

Adds a document to a template document.

TemplateLocks

Template locks

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

Gets template lock information.

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

Updates a template lock.

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

Lock a template.

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

Deletes a template lock.

Templates

Template management

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

Gets the definition of a template.

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

Creates a template.

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

Gets a list of templates for a specified account.

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

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

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

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

Returns document page image(s) based on input.

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

Deletes a page from a document in an template.

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

Gets a page image from a template for display.

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

Rotates page image from a template for display.

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

Gets template notification information.

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

Updates the notification structure for an existing template.

TemplateRecipientTabs

Template tabs

MethodDescription
list
GET /v2/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/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Updates the tabs for a recipient.

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

Adds tabs for a recipient.

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

Deletes the tabs associated with a recipient in a template.

TemplateViews

Embedding template views

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

Provides a URL to start an edit view of the Template UI

TemplateDocumentVisibility

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

Returns document visibility for the recipients

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

Updates document visibility for the recipients

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

Updates document visibility for the recipients

TemplateDocumentResponsiveHtmlPreview

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

TemplateResponsiveHtmlPreview

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

TemplateHtmlDefinitions

MethodDescription
}} />