v1

latestSwagger 2.02026-07-134146194.6 MB
Templates

Creates one or more templates.

Creates one or more template definitions, using a multipart request for each template.

Templates help streamline the sending process when you frequently send the same or similar documents, or send different documents to the same group of people.

When you create a template, you define placeholder roles. Rather than specifying a person, you specify a role that regularly participates in a transaction that uses the template. Then, when you create or send an envelope based on the template, you assign actual recipients to the template roles. The recipients automatically inherit all of the workflow that is defined for that role in the template, such as the tabs and routing information.

Template Email Subject Merge Fields

Placeholder roles have associated merge fields that personalize the email notification that Docusign sends. For example, the template automatically personalizes the email message by adding placeholders for the recipient's name and email address within the email subject line, based on the recipient's role. When the sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.

Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to find out who the recipient is.

Use the following placeholders to insert a recipient's name or email address in the subject line

To insert a recipient's name into the subject line, use the [[<roleName>_UserName]] placeholder in the emailSubject property when you create the template:

To include a recipient's name or email address in the subject line, use the following placeholders in the emailSubject property:

  • [[<roleName>_UserName]]
  • [[<roleName>_Email]]

For example, if the role name is Signer 1, you might set emailSubject to one of these strings:

  • "[[Signer 1_UserName]], Please sign this NDA"
  • "[[Signer 1_Email]], Please sign this NDA"

Note: The maximum length of the subject line is 100 characters, including any merged text.

Creating multiple templates

To create multiple templates, you provide a zip file of JSON files. You can also use the Templates::ListTemplates method with the is_download query parameter to download a zip file containing your existing templates and use that as a guide. The API supports both .zip and .gzip file formats as input.

You also need to set the Content-Length, Content-Type, and Content-Disposition headers:

Content-Length: 71068
Content-Type: application/zip
Content-Disposition: file; filename="DocuSignTemplates_Nov_25_2019_20_40_21.zip"; fileExtension=.zip

Related topics

  • How to create a template
post/v2.1/accounts/{accountId}/templates

Path parameters

accountIdstring required

(Required) The external account number (int) or account ID GUID.

Request body

accessControlListBase64string

Reserved for Docusign.

allowCommentsstring

When true, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.

allowMarkupstring

When true, the Document Markup feature is enabled.

Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.

allowReassignstring

When true, the recipient can redirect an envelope to a more appropriate recipient.

allowViewHistorystring

When true, recipients can view the history of the envelope.

anySignerstring

Deprecated. This feature has been replaced by signing groups.

asynchronousstring

When 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.

Note: A transactionId is required for this call to work correctly. When the envelope is created, the status is Processing and an envelopeId is not returned in the response. To get the envelopeId, use a GET envelope query by using the transactionId or by checking the Connect notification.

attachmentsUristring

Contains a URL for retrieving the attachments that are associated with the envelope.

authoritativeCopystring

When true, marks all of the documents in the envelope as authoritative copies.

Note: You can override this value for a specific document. For example, you can set the authoritativeCopy property to true at the envelope level, but turn it off for a single document by setting the authoritativeCopy property for the document to false.

authoritativeCopyDefaultstring

The default authoritativeCopy setting for documents in this envelope that do not have authoritativeCopy set. If this property is not set, each document defaults to the envelope's authoritativeCopy.

autoMatchstring

By default, templates that have been used within the last 60 days are included in auto-matching.

By explicitly setting autoMatch, you can permanently include or exclude the template in auto matching.

When true the template is included in auto-matching regardless of when it was last used.

When false the template is never included in auto-matching.

autoMatchSpecifiedByUserstring

When true, the template has been explicitly included in or excluded from auto-matching. The default is false. This is a read-only property.

autoNavigationstring

When true, autonavigation is set for the recipient.

brandIdstring

The ID of the brand.

brandLockstring

When true, the brandId for the envelope is locked and senders cannot change the brand used for the envelope.

burnDefaultTabDatastring
certificateUristring

The URI for retrieving certificate information.

completedDateTimestring

Specifies the date and time this item was completed.

copyRecipientDatastring
createdstring

The UTC DateTime when the workspace user authorization was created.

createdDateTimestring

The UTC DateTime when the item was created.

customFieldsUristring

The URI for retrieving custom fields.

declinedDateTimestring

The date and time the recipient declined the document. This property is read-only.

deletedDateTimestring

Reserved for Docusign.

deliveredDateTimestring

The date and time that the envelope was delivered to the recipient. This property is read-only.

descriptionstring

A sender-defined description of the line item.

disableResponsiveDocumentstring

When true, responsive documents are disabled for the envelope.

documentBase64string

The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

documentsCombinedUristring

The URI for retrieving all of the documents associated with the envelope as a single PDF file.

documentsUristring

The URI for retrieving all of the documents associated with the envelope as separate files.

emailBlurbstring

This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.

emailSubjectstring

The subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see Template Email Subject Merge Fields.

Note: The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.

enableWetSignstring

When true, the signer is allowed to print the document and sign it on paper.

enforceSignerVisibilitystring

When true, the option selected in the Document Visibility section in your account Sending Settings will be enforced for the envelope. See Fields and Properties for details about document visibility options. Setting enforceSignerVisibility to true also enables you to omit documents from the specified recipients' envelopes by using the excludedDocuments array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the excludedDocuments setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the excludedDocuments setting.

Note: To use this functionality, document visibility must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your account manager to find out whether document visibility is available for your production account plan.

envelopeIdstring

The envelope ID of an envelope that you want to use as the basis for the template. The state of the envelope can be draft, sent, or completed.

envelopeIdStampingstring

When true, Envelope ID Stamping is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed.

envelopeLocationstring

Reserved for Docusign.

envelopeUristring

The URI for retrieving the envelope or envelopes.

expireAfterstring

Not used. Use the expirations property in the notification object instead.

expireDateTimestring

Not used. Use the expirations property in the notification object instead.

expireEnabledstring

Not used. Use the expirations property in the notification object instead.

externalEnvelopeIdstring

May contain an external identifier for the envelope.

favoritedByMestring
folderIdstring

The ID of the folder.

folderIdsstring[]
folderNamestring
hasCommentsstring

When true, indicates that users have added comments to the envelope.

hasFormDataChangedstring

When true, indicates that the data collected through form fields on a document has changed.

hasWavFilestring

When true, indicates that a .wav file used for voice authentication is included in the envelope.

holderstring

Reserved for Docusign.

initialSentDateTimestring

The date and time the envelope was initially sent.

is21CFRPart11string

When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

isAceGenTemplatestring
isDocGenTemplatestring
isDynamicEnvelopestring

When true, indicates that the envelope is a dynamic envelope.

isSignatureProviderEnvelopestring

When true, indicates that the envelope is a signature-provided envelope.

isTicketRelatedEnvelopestring
lastModifiedstring

The UTC date and time that the comment was last updated.

Note: This can only be done by the creator.

lastModifiedDateTimestring

The date and time that the item was last modified.

lastUsedstring
locationstring

Reserved for Docusign.

messageLockstring

When 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.

namestring
newPasswordstring

The user's new password.

notificationUristring

The URI for retrieving notifications.

pageCountstring

An integer value specifying the number of document pages in the template.

passwordstring

The user's password.

This property is used only when adding a new user via a Users: create request. The value must conform to the password rules defined in the account Security Settings.

This property is not returned by GET requests and cannot be updated via PUT requests.

passwordProtectedstring
purgeCompletedDatestring

The date that a purge was completed.

purgeRequestDatestring

The date that a purge was requested.

purgeStatestring

Shows the current purge state for the envelope. Valid values:

  • unpurged: There has been no successful request to purge documents.
  • documents_queued: The envelope documents have been added to the purge queue, but have not been purged.
  • documents_dequeued: The envelope documents have been taken out of the purge queue.
  • documents_purged: The envelope documents have been successfully purged.
  • documents_and_metadata_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.
  • documents_and_metadata_purged: The envelope documents and metadata have been successfully purged.
  • documents_and_metadata_and_redact_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.
  • documents_and_metadata_and_redact_purged: The envelope documents and metadata have been successfully purged, and personal information has been redacted.

Related topics

recipientsLockstring

When true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

recipientsUristring

Contains a URI for an endpoint that you can use to retrieve the recipients.

sentDateTimestring

The UTC DateTime when the envelope was sent. This property is read-only.

sharedstring

When true, indicates the template is shared with the Everyone group, which includes all users on the account.

When false, the template is shared only with the groups you specify.

signerCanSignOnMobilestring

When true, recipients can sign on a mobile device.

Note: Only Admin users can change this setting.

signingLocationstring

Specifies the physical location where the signing takes place. It can have two enumeration values; inPerson and online. The default value is online.

statusstring

Indicates the envelope status. Valid values are:

  • completed: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
  • created: The envelope is created as a draft. It can be modified and sent later.
  • declined: The envelope has been declined by the recipients.
  • delivered: The envelope has been delivered to the recipients.
  • sent: The envelope will be sent to the recipients after the envelope is created.
  • signed: The envelope has been signed by the recipients.
  • voided: The envelope is no longer valid and recipients cannot access or sign the envelope.
statusChangedDateTimestring

The data and time that the status changed.

templateIdstring

The unique identifier of the template. If this is not provided, Docusign will generate a value.

templatesUristring

The URI for retrieving the templates.

transactionIdstring

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 c onnection was lost before the envelope status was returned.

uristring

A URI containing the user ID.

useDisclosurestring

When true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When 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.

uSigStatestring
voidedDateTimestring

The date and time the envelope or template was voided.

voidedReasonstring

The reason the envelope or template was voided.

Note: The string is truncated to the first 200 characters.

Response

Successful response.