Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Template Locks

Updates a template lock

PUT
/v2.1/accounts/{accountId}/templates/{templateId}/lock

Updates the lock information for a locked template.

You must include the X-DocuSign-Edit header as described in TemplateLocks: create.

Use this method to change the duration of the lock (lockDurationInSeconds) or the lockedByApp string.

The request body is a full lockRequest object, but you only need to specify the properties that you are updating. For example:

{  "lockDurationInSeconds": "3600",  "lockedByApp": "My Application"}

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

templateId*string

The ID of the template.

Request Body

application/json

This request object contains information about the lock that you want to create or update.

lockDurationInSeconds?string

The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.

lockedByApp?string

A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.

lockType?string

The type of lock. Currently edit is the only supported type.

templatePassword?string

The password for the template. 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.

useScratchPad?string

When true, a scratchpad is used to edit information.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/lock" \  -H "Content-Type: application/json" \  -d '{}'
{  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "lockDurationInSeconds": "string",  "lockedByApp": "string",  "lockedByUser": {    "accountId": "string",    "accountName": "string",    "activationAccessCode": "string",    "email": "string",    "errorDetails": {      "errorCode": "string",      "message": "string"    },    "ipAddress": "string",    "loginStatus": "string",    "membershipId": "string",    "sendActivationEmail": "string",    "uri": "string",    "userId": "string",    "userName": "string",    "userStatus": "string",    "userType": "string"  },  "lockedUntilDateTime": "string",  "lockToken": "string",  "lockType": "string",  "useScratchPad": "string"}

Deletes a template lock DELETE

Deletes the lock from the specified template. The user deleting the lock must be the same user who locked the template. You must include the `X-DocuSign-Edit` header as described in [TemplateLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/create/). This method takes an optional query parameter that lets you specify whether changes made while the template was locked are kept or discarded. | Query Parameter | Description | | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the template was locked are discarded. | ### Related topics - [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)

Gets the list of templates GET

Retrieves the list of templates for the specified account. The request can be limited to a specific folder. ### Related topics - [How to create a template](https://developers.docusign.com/docs/esign-rest-api/how-to/create-template/)