Lock template

POST

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

POST

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

curl -X POST https://demo.docusign.net/restapi/v2/accounts/accountId/templates/templateId/lock \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "errorDetails": {
    "errorCode": "string",
    "message": "string"
  },
  "lockDurationInSeconds": "string",
  "lockedByApp": "string",
  "lockedByUser": {
    "activationAccessCode": "string",
    "email": "string",
    "errorDetails": {
      "errorCode": "string",
      "message": "string"
    },
    "loginStatus": "string",
    "sendActivationEmail": "string",
    "uri": "string",
    "userId": "string",
    "userName": "string",
    "userStatus": "string",
    "userType": "string"
  },
  "lockedUntilDateTime": "string",
  "lockToken": "string",
  "lockType": "string",
  "useScratchPad": "string"
}

Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.

Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

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

templateIdstringRequired

The ID of the template being accessed.

Request

This endpoint expects an object: lockRequest

lockDurationInSecondsstringOptional

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

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 envelope lock. Currently "edit" is the only supported type.

templatePasswordstringOptional

useScratchPadstringOptional

Reserved for future use.

Indicates whether a scratchpad is used for editing 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. Must be greater than 0 seconds.

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.

lockedByUserobjectOptional

lockedUntilDateTimestringOptional

The datetime until the envelope lock expires.

lockTokenstringOptional

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.