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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
body | Model | Optional | Expand Updates an existing template — request body — body |
Referenced models: Updates an existing template — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Creates one or more templates — response body |
Referenced models: Creates one or more templates — response body
Schemas
Section titled “Schemas”148 more schemas are linked from the tables above, on the schema pages.
Creates one or more templates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Summary of a template request. |
applied | string | Optional | Reserved for Docusign. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing document's ID attribute. |
documentName | string | Optional | The name of the document. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
name | string | Optional | The name of the template. |
templateId | string | Optional | The unique identifier of the template. If this is not provided, Docusign will generate a value. |
templateMatch | Model | Optional | Expand Creates one or more templates — response body — template Match |
uri | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Creates one or more templates — response body — template Match
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documentEndPage | string | Optional | |
documentStartPage | string | Optional | |
matchPercentage | string | Optional |
Gets a list of custom fields — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
lockDurationInSeconds | string | Optional | 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. |
lockToken | string | Optional | A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. |
lockType | string | Optional | The type of lock. Currently `edit` is the only supported type. |
lockedByApp | string | Optional | The 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. |
lockedByUser | Model | Optional | Expand 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. |
lockedUntilDateTime | string | Optional | The date and time that the lock expires. |
useScratchPad | string | Optional | When **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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an attachment. |
accessControl | string | Optional | Valid values are `sender` and `senderAndAllRecipients`. |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. |
data | string | Optional | A 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. |
label | string | Optional | A 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. |
name | string | Optional | The name of the attachment. |
remoteUrl | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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@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 | array | Optional | An 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[] | Model | Each item | Expand Adds email setting overrides to an envelope — response body — bcc Email Addresses item |
replyEmailAddressOverride | string | Optional | The 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. |
replyEmailNameOverride | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeCustomMetadataDetails | array | Optional | |
envelopeCustomMetadataDetails[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes document generation errors. |
errorCode | string | Optional | A code associated with the error condition. |
message | string | Optional | The error message. |
tagIdentifier | string | Optional | The 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.