TemplateLocks

Deletes a template lock.

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.

This method takes an optional query parameter that lets you specify whether changes made while the template was locked are kept or discarded.

Query ParameterDescription
save_changesWhen 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

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

Request

  • Base URL
    https://www.docusign.net/restapi
  • URL
    https://www.docusign.net/restapi/v2.1/accounts/{accountId}/templates/{templateId}/lock
  • Auth
    none declared

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.

Changes

No recorded changes to this operation across all 39 revisions of this API.