Skip to content

DocuSign: Creates one or more templates

DocuSign esignature.esignatureTemplatesPostTemplates: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_templates_posttemplates

Provider route: POST /restapi/v2.1/accounts/{accountId}/templates. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureTemplatesPostTemplates"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureTemplatesPostTemplates(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_templates_post_templates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
bodyModelOptionalExpand Updates an existing template — request body — body

Referenced models: Updates an existing template — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates one or more templates — response body

Referenced models: Creates one or more templates — response body

148 more schemas are linked from the tables above, on the schema pages.

Creates one or more templates — response body
FieldTypePresenceDescription and constraints
$objectRootSummary of a template request.
appliedstringOptionalReserved for Docusign.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing document's ID attribute.
documentNamestringOptionalThe name of the document.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the template.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templateMatchModelOptionalExpand Creates one or more templates — response body — template Match
uristringOptionalA URI containing the user ID.

Referenced models: Locks a template — response body — error Details, Creates one or more templates — response body — template Match

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Creates one or more templates — response body — template Match
FieldTypePresenceDescription and constraints
$objectRoot
documentEndPagestringOptional
documentStartPagestringOptional
matchPercentagestringOptional
Gets a list of custom fields — response body
FieldTypePresenceDescription and constraints
$objectRootAn `accountCustomField` is an envelope custom field that you set at the account level.
Applying custom fields enables account administrators to group and manage envelopes.
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item

Locks an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootEnvelope locks let you lock an envelope to prevent any changes while you are updating an envelope.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringOptional
The number of seconds until the lock expires when there is no activity on the envelope.

The default value is 300 seconds. The maximum value is 1,800 seconds.

The lock duration can be extended.
lockTokenstringOptionalA unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalThe human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.
lockedByUserModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
A complex type containing information about the user that has the envelope or template locked.
lockedUntilDateTimestringOptionalThe date and time that the lock expires.
useScratchPadstringOptionalWhen **true,** a scratchpad is used to edit information.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Updates an envelope attachment in a draft or in-process envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRootContains information about an attachment.
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient.
datastringOptionalA Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
labelstringOptionalA label for the attachment. Potential values include:

- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.
- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.
Adds email setting overrides to an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootA 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@example.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@example.com', then a copy of the envelope is only sent to the 'salesarchive@example.com' email address.
bccEmailAddressesarrayOptionalAn array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.

While this property is an array, note that it takes only a single email address.

**Note:** Only users with the `canManageAccount` setting set to **true** can use this option.

Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope.

**Example:** if your account has BCC for Email Archive set up for the email address archive@example.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@example.com, then a copy of the envelope is only sent to the salesarchive@example.com email address.
bccEmailAddresses[]ModelEach itemExpand Adds email setting overrides to an envelope — response body — bcc Email Addresses item
replyEmailAddressOverridestringOptionalThe Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.
replyEmailNameOverridestringOptionalThe name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.

Referenced models: Adds email setting overrides to an envelope — response body — bcc Email Addresses item

Gets the status of a single envelope — response body — envelope Custom Metadata
FieldTypePresenceDescription and constraints
$objectRoot
envelopeCustomMetadataDetailsarrayOptional
envelopeCustomMetadataDetails[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Updates a template document — response body — doc Gen Errors item
FieldTypePresenceDescription and constraints
$objectRootDescribes document generation errors.
errorCodestringOptionalA code associated with the error condition.
messagestringOptionalThe error message.
tagIdentifierstringOptionalThe tag that caused the syntax error.
See [Document Generation Syntax](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ftc1679700030026.html)
to learn more about document generation syntax rules.

SDK function policy ID: docusign.esignature_templates_posttemplates. Catalog operation: esignature:Templates_PostTemplates. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.