Skip to content

DocuSign: Updates a template lock

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

← Esignature operations · Get started

Operation docusign.esignature_lock_puttemplatelock

Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/{templateId}/lock. 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"]["esignatureLockPutTemplateLock"]>[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.esignatureLockPutTemplateLock(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_lock_put_template_lock(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 Locks a template — request body — body

Referenced models: Locks a 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 Locks a template — response body

Referenced models: Locks a template — response body

Locks a template — response body
FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringOptionalThe number of seconds to lock the envelope for editing. This value must be greater than `0` seconds.
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

Locks a template — request body — body
FieldTypePresenceDescription and constraints
$objectRootThis request object contains information about the lock that you want to create or update.
lockDurationInSecondsstringOptionalThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
templatePasswordstringOptionalThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes.
useScratchPadstringOptionalWhen **true,** a scratchpad is used to edit information.
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 specific template associated with a specified account — response body — owner
FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe account ID associated with the envelope.
accountNamestringOptionalThe name on the account.
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
emailstringOptionalThe user's email address.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
ipAddressstringOptional
loginStatusstringOptionalWhen **true,** indicates that the user is logged in. This is a read-only property.
membershipIdstringOptionalThe user's membership ID.
sendActivationEmailstringOptionalThis field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
uristringOptionalA URI containing the user ID.
userIdstringOptionalThe ID of the user to access.
userNamestringOptionalThe name of the user.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.

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

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