Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
TemplateLocks

Locks a template.

This method locks the specified template and sets the time until the lock expires to prevent other users or recipients from changing the template.

The response to this request includes a lockToken parameter that you must use in the X-DocuSign-Edit header for every PUT method (typically a method that updates a template) while the template is locked.

If you do not provide the lockToken when accessing a locked template, you will get the following error:

{
   "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER",
   "message": "The user is not the owner of the lock. The template is locked by another user or in another application"
}

The X-DocuSign-Edit header

The X-DocuSign-Edit header looks like this and can be specified in either JSON or XML.

JSON

{
  "LockToken": "token-from-response",
  "LockDurationInSeconds": "600"
}

XML

<DocuSignEdit>
  <LockToken>token-from-response</LockToken>
  <LockDurationInSeconds>600</LockDurationInSeconds>
</DocuSignEdit>

In the actual HTTP header, you would remove the linebreaks:

X-DocuSign-Edit: {"LockToken": "token-from-response", "LockDurationInSeconds": "600" }
    or
X-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>

Related topics

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

Path parameters

accountIdstring required

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

templateIdstring required

The ID of the template.

Request body

lockDurationInSecondsstring

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

lockedByAppstring

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

lockTypestring

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

templatePasswordstring

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.

useScratchPadstring

When true, a scratchpad is used to edit information.

Response

Successful response.