Skip to content

DocuSign: Updates an existing template

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

← Esignature operations · Get started

Operation docusign.esignature_templates_puttemplate

Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/{templateId}. 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"]["esignatureTemplatesPutTemplate"]>[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.esignatureTemplatesPutTemplate(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_put_template(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
path.templateIdstringRequired 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 Updates an existing template — response body

Referenced models: Updates an existing template — response body

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

Updates an existing template — response body
FieldTypePresenceDescription and constraints
$objectRoot
bulkEnvelopeStatusModelOptionalExpand Creates an envelope — response body — bulk Envelope Status
An object that describes the status of the bulk send envelopes.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
listCustomFieldUpdateResultsarrayOptional
listCustomFieldUpdateResults[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
purgeStatestringOptionalShows 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)](/docs/esign-rest-api/esign101/concepts/documents/purging/)
- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)

recipientUpdateResultsarrayOptionalAn array of `recipientUpdateResults` objects that contain details about the recipients.
recipientUpdateResults[]ModelEach itemExpand Updates an existing template — response body — recipient Update Results item
tabUpdateResultsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body
textCustomFieldUpdateResultsarrayOptional
textCustomFieldUpdateResults[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Locks an envelope — response body, Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, Creates an envelope — response body — bulk Envelope Status, Locks a template — response body — error Details, Gets a list of custom fields — response body — list Custom Fields item, Updates an existing template — response body — recipient Update Results 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

Creates an envelope — response body — bulk Envelope Status
FieldTypePresenceDescription and constraints
$objectRoot
batchIdstringOptionalSpecifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
batchSizestringOptionalThe number of items returned in this response.
bulkEnvelopesarrayOptionalA list of bulk envelope objects.
bulkEnvelopes[]ModelEach itemExpand Creates an envelope — response body — bulk Envelope Status bulk Envelopes item
bulkEnvelopesBatchUristringOptionalURI at which you can retrieve the batch envelopes.
endPositionstringOptionalThe last index position in the result set.
failedstringOptionalThe number of entries with a status of failed.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
queuedstringOptionalThe number of entries with a status of queued.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
sentstringOptionalThe number of entries with a status of sent.
startPositionstringOptionalThe starting index position of the current result set.
submittedDatestringOptionalThe date on which the bulk envelope was created.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Creates an envelope — response body — bulk Envelope Status bulk Envelopes item

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.
Gets a list of custom fields — response body — list Custom Fields item
FieldTypePresenceDescription and constraints
$objectRootThis object represents a list custom field from which envelope creators and senders can select custom data.
configurationTypestringOptionalIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
fieldIdstringOptionalThe ID of the custom field.
listItemsarrayOptionalAn array of strings that represents the options in a list.

Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters.
listItems[]stringEach item
namestringOptionalThe name of the custom field.
requiredstringOptionalWhen **true,** senders are required to select an option from the list before they can send the envelope.
showstringOptionalWhen **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.
valuestringOptionalThe value of the custom field. This is the value that the user who creates or sends the envelope selects from the list.

Referenced models: Locks a template — response body — error Details

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

Returns tabs on a template — response body — ssn Tabs item connected Object Details
FieldTypePresenceDescription and constraints
$objectRoot
recordIdstringOptional

SDK function policy ID: docusign.esignature_templates_puttemplate. Catalog operation: esignature:Templates_PutTemplate. 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.