Update template lock

PUT

/v2.1/accounts/:accountId/templates/:templateId/lock

PUT

/restapi/v2.1/accounts/:accountId/templates/:templateId/lock

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/templates/TEMPLATE_ID/lock \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "lockDurationInSeconds": "sample string 1",
  "lockedByApp": "sample string 2",
  "lockType": "sample string 3",
  "templatePassword": "sample string 4",
  "useScratchPad": "sample string 5"
}'

{
  "errorDetails": {
    "errorCode": "sample string 1",
    "message": "sample string 2"
  },
  "lockDurationInSeconds": "sample string 1",
  "lockedByApp": "sample string 2",
  "lockedByUser": {
    "accountId": "sample string 1",
    "accountName": "sample string 2",
    "activationAccessCode": "sample string 3",
    "email": "sample string 4",
    "ipAddress": "sample string 5",
    "loginStatus": "sample string 6",
    "membershipId": "sample string 7",
    "sendActivationEmail": "sample string 8",
    "uri": "sample string 9",
    "userId": "sample string 10",
    "userName": "sample string 11",
    "userStatus": "sample string 12",
    "userType": "sample string 13"
  },
  "lockedUntilDateTime": "sample string 3",
  "lockToken": "sample string 4",
  "lockType": "sample string 5",
  "useScratchPad": "sample string 6"
}

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"
}

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

templateIdstringRequired

The ID of the template.

Request

This endpoint expects an object: lockRequest

lockDurationInSecondsstringOptional

The configured value is not used; the timeout is hardcoded to 600 seconds. To use a different timeout, implement a custom timer and explicitly control locking and unlocking.

lockedByAppstringOptional

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

lockTypestringOptional

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

templatePasswordstringOptional

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.

useScratchPadstringOptional

When true, a scratchpad is used to edit information.

Response

Successful response.

errorDetailsobjectOptional

This object describes errors that occur. It is only valid for responses, and ignored in requests.

lockDurationInSecondsstringOptional

The number of seconds to lock the envelope for editing. This value must be greater than 0 seconds.

lockedByAppstringOptional

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.

lockedByUserobjectOptional

lockedUntilDateTimestringOptional

The date and time that the lock expires.

lockTokenstringOptional

A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.

lockTypestringOptional

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

useScratchPadstringOptional

When true, a scratchpad is used to edit information.

Errors

400

Bad Request Error