docusign.templates.post-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

Creates one or more templates.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	(Required) The external account number (int) or account ID GUID.
accesscontrollistbase64	string	No	—	Reserved for Docusign.
allowcomments	string	No	—	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.
allowmarkup	string	No	—	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.
allowreassign	string	No	—	When true, the recipient can redirect an envelope to a more appropriate recipient.
allowviewhistory	string	No	—	When true, recipients can view the history of the envelope.
anysigner	string	No	—	Deprecated. This feature has been replaced by signing groups.
asynchronous	string	No	—	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.
attachmentsuri	string	No	—	Contains a URL for retrieving the attachments that are associated with the envelope.
authoritativecopy	string	No	—	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.
authoritativecopydefault	string	No	—	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.
automatch	string	No	—	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.
automatchspecifiedbyuser	string	No	—	When true, the template has been explicitly included in or excluded from auto-matching. The default is false. This is a read-only property.
autonavigation	string	No	—	When true, autonavigation is set for the recipient.
brandid	string	No	—	The ID of the brand.
brandlock	string	No	—	When true, the brandId for the envelope is locked and senders cannot change the brand used for the envelope.
burndefaulttabdata	string	No	—	—
certificateuri	string	No	—	The URI for retrieving certificate information.
completeddatetime	string	No	—	Specifies the date and time this item was completed.
copyrecipientdata	string	No	—	—
created	string	No	—	The UTC DateTime when the workspace user authorization was created.
createddatetime	string	No	—	The UTC DateTime when the item was created.
customfields	json	No	—	An accountCustomField is an envelope custom field that you set at the account level. Applying custom fields enables account administrators to group and manage envelopes.
customfieldsuri	string	No	—	The URI for retrieving custom fields.
declineddatetime	string	No	—	The date and time the recipient declined the document. This property is read-only.
deleteddatetime	string	No	—	Reserved for Docusign.
delivereddatetime	string	No	—	The date and time that the envelope was delivered to the recipient. This property is read-only.
description	string	No	—	A sender-defined description of the line item.
disableresponsivedocument	string	No	—	When true, responsive documents are disabled for the envelope.
documentbase64	string	No	—	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.
documents	list	No	—	A complex element that contains details about the documents associated with the envelope.
documentscombineduri	string	No	—	The URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsuri	string	No	—	The URI for retrieving all of the documents associated with the envelope as separate files.
emailblurb	string	No	—	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.
emailsettings	json	No	—	A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. Docusign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. Docusign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.
emailsubject	string	No	—	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.
enablewetsign	string	No	—	When true, the signer is allowed to print the document and sign it on paper.
enforcesignervisibility	string	No	—	When true, the option selected in the Document Visibility section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] 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][docviz] 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][support] or your account manager to find out whether document visibility is available for your production account plan. [docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/ [sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending [fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html [support]: https://support.docusign.com/en/contactSupport#
envelopeattachments	list	No	—	An array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopecustommetadata	json	No	—	—
envelopedocuments	list	No	—	An array containing information about the documents that are included in the envelope.
envelopeid	string	No	—	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.
envelopeidstamping	string	No	—	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.
envelopelocation	string	No	—	Reserved for Docusign.
envelopemetadata	json	No	—	—
envelopeuri	string	No	—	The URI for retrieving the envelope or envelopes.
expireafter	string	No	—	Not used. Use the expirations property in the notification object instead.
expiredatetime	string	No	—	Not used. Use the expirations property in the notification object instead.
expireenabled	string	No	—	Not used. Use the expirations property in the notification object instead.
externalenvelopeid	string	No	—	May contain an external identifier for the envelope.
favoritedbyme	string	No	—	—
folderid	string	No	—	The ID of the folder.
folderids	list	No	—	—
foldername	string	No	—	—
folders	list	No	—	A list of folder objects.
hascomments	string	No	—	When true, indicates that users have added comments to the envelope.
hasformdatachanged	string	No	—	When true, indicates that the data collected through form fields on a document has changed.
haswavfile	string	No	—	When true, indicates that a .wav file used for voice authentication is included in the envelope.
holder	string	No	—	Reserved for Docusign.
initialsentdatetime	string	No	—	The date and time the envelope was initially sent.
is21cfrpart11	string	No	—	When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isacegentemplate	string	No	—	—
isdocgentemplate	string	No	—	—
isdynamicenvelope	string	No	—	When true, indicates that the envelope is a dynamic envelope.
issignatureproviderenvelope	string	No	—	When true, indicates that the envelope is a signature-provided envelope.
isticketrelatedenvelope	string	No	—	—
lastmodified	string	No	—	The UTC date and time that the comment was last updated. Note: This can only be done by the creator.
lastmodifiedby	json	No	—	—
lastmodifieddatetime	string	No	—	The date and time that the item was last modified.
lastused	string	No	—	—
location	string	No	—	Reserved for Docusign.
lockinformation	json	No	—	Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.
messagelock	string	No	—	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.
name	string	No	—	—
newpassword	string	No	—	The user's new password.
notification	json	No	—	A complex element that specifies the notification settings for the envelope.
notificationuri	string	No	—	The URI for retrieving notifications.
owner	json	No	—	—
pagecount	string	No	—	An integer value specifying the number of document pages in the template.
password	string	No	—	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.
passwordprotected	string	No	—	—
powerform	json	No	—	Contains details about a PowerForm.
powerforms	list	No	—	An array of PowerForm objects.
purgecompleteddate	string	No	—	The date that a purge was completed.
purgerequestdate	string	No	—	The date that a purge was requested.
purgestate	string	No	—	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 - Purging documents (eSingature Concepts) - Purging documents in an envelope (blog post)
recipients	json	No	—	Envelope recipients
recipientslock	string	No	—	When true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsuri	string	No	—	Contains a URI for an endpoint that you can use to retrieve the recipients.
sender	json	No	—	—
sentdatetime	string	No	—	The UTC DateTime when the envelope was sent. This property is read-only.
shared	string	No	—	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.
signercansignonmobile	string	No	—	When true, recipients can sign on a mobile device. Note: Only Admin users can change this setting.
signinglocation	string	No	—	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	No	—	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.
statuschangeddatetime	string	No	—	The data and time that the status changed.
templateid	string	No	—	The unique identifier of the template. If this is not provided, Docusign will generate a value.
templatesuri	string	No	—	The URI for retrieving the templates.
transactionid	string	No	—	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.
uri	string	No	—	A URI containing the user ID.
usedisclosure	string	No	—	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.
usigstate	string	No	—	—
voideddatetime	string	No	—	The date and time the envelope or template was voided.
voidedreason	string	No	—	The reason the envelope or template was voided. Note: The string is truncated to the first 200 characters.
workflow	json	No	—	Describes the workflow for an envelope.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	(Required) The external account number (int) or account ID GUID.
accesscontrollistbase64	string	No	—	Reserved for Docusign.
allowcomments	string	No	—	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.
allowmarkup	string	No	—	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.
allowreassign	string	No	—	When true, the recipient can redirect an envelope to a more appropriate recipient.
allowviewhistory	string	No	—	When true, recipients can view the history of the envelope.
anysigner	string	No	—	Deprecated. This feature has been replaced by signing groups.
asynchronous	string	No	—	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.
attachmentsuri	string	No	—	Contains a URL for retrieving the attachments that are associated with the envelope.
authoritativecopy	string	No	—	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.
authoritativecopydefault	string	No	—	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.
automatch	string	No	—	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.
automatchspecifiedbyuser	string	No	—	When true, the template has been explicitly included in or excluded from auto-matching. The default is false. This is a read-only property.
autonavigation	string	No	—	When true, autonavigation is set for the recipient.
brandid	string	No	—	The ID of the brand.
brandlock	string	No	—	When true, the brandId for the envelope is locked and senders cannot change the brand used for the envelope.
burndefaulttabdata	string	No	—	—
certificateuri	string	No	—	The URI for retrieving certificate information.
completeddatetime	string	No	—	Specifies the date and time this item was completed.
copyrecipientdata	string	No	—	—
created	string	No	—	The UTC DateTime when the workspace user authorization was created.
createddatetime	string	No	—	The UTC DateTime when the item was created.
customfields	json	No	—	An accountCustomField is an envelope custom field that you set at the account level. Applying custom fields enables account administrators to group and manage envelopes.
customfieldsuri	string	No	—	The URI for retrieving custom fields.
declineddatetime	string	No	—	The date and time the recipient declined the document. This property is read-only.
deleteddatetime	string	No	—	Reserved for Docusign.
delivereddatetime	string	No	—	The date and time that the envelope was delivered to the recipient. This property is read-only.
description	string	No	—	A sender-defined description of the line item.
disableresponsivedocument	string	No	—	When true, responsive documents are disabled for the envelope.
documentbase64	string	No	—	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.
documents	list	No	—	A complex element that contains details about the documents associated with the envelope.
documentscombineduri	string	No	—	The URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsuri	string	No	—	The URI for retrieving all of the documents associated with the envelope as separate files.
emailblurb	string	No	—	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.
emailsettings	json	No	—	A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. Docusign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. Docusign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.
emailsubject	string	No	—	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.
enablewetsign	string	No	—	When true, the signer is allowed to print the document and sign it on paper.
enforcesignervisibility	string	No	—	When true, the option selected in the Document Visibility section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] 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][docviz] 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][support] or your account manager to find out whether document visibility is available for your production account plan. [docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/ [sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending [fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html [support]: https://support.docusign.com/en/contactSupport#
envelopeattachments	list	No	—	An array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopecustommetadata	json	No	—	—
envelopedocuments	list	No	—	An array containing information about the documents that are included in the envelope.
envelopeid	string	No	—	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.
envelopeidstamping	string	No	—	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.
envelopelocation	string	No	—	Reserved for Docusign.
envelopemetadata	json	No	—	—
envelopeuri	string	No	—	The URI for retrieving the envelope or envelopes.
expireafter	string	No	—	Not used. Use the expirations property in the notification object instead.
expiredatetime	string	No	—	Not used. Use the expirations property in the notification object instead.
expireenabled	string	No	—	Not used. Use the expirations property in the notification object instead.
externalenvelopeid	string	No	—	May contain an external identifier for the envelope.
favoritedbyme	string	No	—	—
folderid	string	No	—	The ID of the folder.
folderids	list	No	—	—
foldername	string	No	—	—
folders	list	No	—	A list of folder objects.
hascomments	string	No	—	When true, indicates that users have added comments to the envelope.
hasformdatachanged	string	No	—	When true, indicates that the data collected through form fields on a document has changed.
haswavfile	string	No	—	When true, indicates that a .wav file used for voice authentication is included in the envelope.
holder	string	No	—	Reserved for Docusign.
initialsentdatetime	string	No	—	The date and time the envelope was initially sent.
is21cfrpart11	string	No	—	When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isacegentemplate	string	No	—	—
isdocgentemplate	string	No	—	—
isdynamicenvelope	string	No	—	When true, indicates that the envelope is a dynamic envelope.
issignatureproviderenvelope	string	No	—	When true, indicates that the envelope is a signature-provided envelope.
isticketrelatedenvelope	string	No	—	—
lastmodified	string	No	—	The UTC date and time that the comment was last updated. Note: This can only be done by the creator.
lastmodifiedby	json	No	—	—
lastmodifieddatetime	string	No	—	The date and time that the item was last modified.
lastused	string	No	—	—
location	string	No	—	Reserved for Docusign.
lockinformation	json	No	—	Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.
messagelock	string	No	—	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.
name	string	No	—	—
newpassword	string	No	—	The user's new password.
notification	json	No	—	A complex element that specifies the notification settings for the envelope.
notificationuri	string	No	—	The URI for retrieving notifications.
owner	json	No	—	—
pagecount	string	No	—	An integer value specifying the number of document pages in the template.
password	string	No	—	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.
passwordprotected	string	No	—	—
powerform	json	No	—	Contains details about a PowerForm.
powerforms	list	No	—	An array of PowerForm objects.
purgecompleteddate	string	No	—	The date that a purge was completed.
purgerequestdate	string	No	—	The date that a purge was requested.
purgestate	string	No	—	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 - Purging documents (eSingature Concepts) - Purging documents in an envelope (blog post)
recipients	json	No	—	Envelope recipients
recipientslock	string	No	—	When true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsuri	string	No	—	Contains a URI for an endpoint that you can use to retrieve the recipients.
sender	json	No	—	—
sentdatetime	string	No	—	The UTC DateTime when the envelope was sent. This property is read-only.
shared	string	No	—	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.
signercansignonmobile	string	No	—	When true, recipients can sign on a mobile device. Note: Only Admin users can change this setting.
signinglocation	string	No	—	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	No	—	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.
statuschangeddatetime	string	No	—	The data and time that the status changed.
templateid	string	No	—	The unique identifier of the template. If this is not provided, Docusign will generate a value.
templatesuri	string	No	—	The URI for retrieving the templates.
transactionid	string	No	—	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.
uri	string	No	—	A URI containing the user ID.
usedisclosure	string	No	—	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.
usigstate	string	No	—	—
voideddatetime	string	No	—	The date and time the envelope or template was voided.
voidedreason	string	No	—	The reason the envelope or template was voided. Note: The string is truncated to the first 200 characters.
workflow	json	No	—	Describes the workflow for an envelope.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /v2.1/accounts/{accountId}/templates
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /v2.1/accounts/{accountId}/templates
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.templates.post-templates",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}