> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # 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 supported | Method | Description | | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [create](/docs/esign-rest-api/v2/reference/templates/templates/create) | POST `/restapi/v2/accounts/{accountId}/templates` Creates a template. | | [deleteDocumentPage](/docs/esign-rest-api/v2/reference/templates/templates/deletedocumentpage) | DEL `/restapi/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}` Deletes a page from a document in an template. | | [deleteGroupShare](/docs/esign-rest-api/v2/reference/templates/templates/deletegroupshare) | DEL `/restapi/v2/accounts/{accountId}/templates/{templateId}/{templatePart}` Removes a member group's sharing permissions for a template. | | [get](/docs/esign-rest-api/v2/reference/templates/templates/get) | GET `/restapi/v2/accounts/{accountId}/templates/{templateId}` Gets a list of templates for a specified account. | | [getDocumentPageImage](/docs/esign-rest-api/v2/reference/templates/templates/getdocumentpageimage) | GET `/restapi/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image` Gets a page image from a template for display. | | [getNotificationSettings](/docs/esign-rest-api/v2/reference/templates/templates/getnotificationsettings) | GET `/restapi/v2/accounts/{accountId}/templates/{templateId}/notification` Gets template notification information. | | [getPageImages](/docs/esign-rest-api/v2/reference/templates/templates/getpageimages) | GET `/restapi/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages` Returns document page image(s) based on input. | | [list](/docs/esign-rest-api/v2/reference/templates/templates/list) | GET `/restapi/v2/accounts/{accountId}/templates` Gets the definition of a template. | | [rotateDocumentPage](/docs/esign-rest-api/v2/reference/templates/templates/rotatedocumentpage) | PUT `/restapi/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image` Rotates page image from a template for display. | | [update](/docs/esign-rest-api/v2/reference/templates/templates/update) | PUT `/restapi/v2/accounts/{accountId}/templates/{templateId}` Updates an existing template. | | [updateGroupShare](/docs/esign-rest-api/v2/reference/templates/templates/updategroupshare) | PUT `/restapi/v2/accounts/{accountId}/templates/{templateId}/{templatePart}` Shares a template with a group | | [updateNotificationSettings](/docs/esign-rest-api/v2/reference/templates/templates/updatenotificationsettings) | PUT `/restapi/v2/accounts/{accountId}/templates/{templateId}/notification` Updates the notification structure for an existing template. | ## Templates properties | Property | Type | Description | | ----------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowMarkup` | string | When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this | | `allowReassign` | string | When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. | | `allowViewHistory` | string | | | `asynchronous` | string | When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. | | `attachmentsUri` | string | | | `authoritativeCopy` | string | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. | | `authoritativeCopyDefault` | string | | | `autoNavigation` | string | | | `brandId` | string | | | `brandLock` | string | | | `certificateUri` | string | Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. | | `completedDateTime` | string | Specifies the date and time this item was completed. | | `copyRecipientData` | string | | | `createdDateTime` | string | Indicates the date and time the item was created. | | `customFields` | AccountCustomFields | An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. | | `customFieldsUri` | string | Contains a URI for an endpoint that you can use to retrieve the custom fields. | | `declinedDateTime` | string | The date and time the recipient declined the document. | | `deletedDateTime` | string | Specifies the data and time the item was deleted. | | `deliveredDateTime` | string | Reserved: For DocuSign use only. | | `disableResponsiveDocument` | string | | | `documents` | array | Complex element contains the details on the documents in the envelope. | | `documentsCombinedUri` | string | | | `documentsUri` | string | Contains a URI for an endpoint that you can use to retrieve the documents. | | `emailBlurb` | string | | | `emailSettings` | emailSettings | A complex type that contains email settings. | | `emailSubject` | string | Specifies the subject of the email that is sent to all recipients. See \[ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. | | `enableWetSign` | string | When set to **true**, the signer is allowed to print the document and sign it on paper. | | `enforceSignerVisibility` | string | When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. | | `envelopeId` | string | The envelope ID of the envelope status that failed to post. | | `envelopeIdStamping` | string | When set to **true**, Envelope ID Stamping is enabled. | | `envelopeTemplateDefinition` | envelopeTemplateDefinition | | | `envelopeUri` | string | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. | | `initialSentDateTime` | string | | | `is21CFRPart11` | string | When set to **true**, indicates that this module is enabled on the account. | | `isSignatureProviderEnvelope` | string | | | `lastModifiedDateTime` | string | The date and time the item was last modified. | | `lockInformation` | EnvelopeLocks | Provides lock information about an envelope that a user has locked. | | `messageLock` | string | When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. | | `notification` | notification | | | `notificationUri` | string | Contains a URI for an endpoint that you can use to retrieve the notifications. | | `purgeState` | string | | | `recipients` | EnvelopeRecipients | An array of powerform recipients. | | `recipientsLock` | string | When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. | | `recipientsUri` | string | Contains a URI for an endpoint that you can use to retrieve the recipients. | | `sentDateTime` | string | The date and time the envelope was sent. | | `signerCanSignOnMobile` | string | | | `signingLocation` | string | Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. | | `status` | string | Indicates the envelope status. Valid values are:- sent - The envelope is sent to the recipients. - created - The envelope is saved as a draft and can be modified and sent later. | | `statusChangedDateTime` | string | The data and time the status changed. | | `templatesUri` | string | Contains a URI for an endpoint which you can use to retrieve the templates. | | `transactionId` | string | Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. | | `useDisclosure` | string | When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. | | `voidedDateTime` | string | The date and time the envelope or template was voided. | | `voidedReason` | string | The reason the envelope or template was voided. | ## API Docs - Templates [Create templates](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/create.md) - Templates [Delete page from document in template](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/deletedocumentpage.md) - Templates [Remove template sharing for groups](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/deletegroupshare.md) - Templates [Get template](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/get.md) - Templates [Get page image from template for display](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/getdocumentpageimage.md) - Templates [Get template notification information](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/getnotificationsettings.md) - Templates [Get document page image based on input](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/getpageimages.md) - Templates [List templates](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/list.md) - Templates [Rotate page image from template for display](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/rotatedocumentpage.md) - Templates [Update template](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/update.md) - Templates [Share template with group](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/updategroupshare.md) - Templates [Update notification structure for template](https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templates/updatenotificationsettings.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.docusign.com/openapi.json) - [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)