Envelope Locks

Deletes an envelope lock

DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Deletes the lock from the specified envelope. The user deleting the lock must be the same user who locked the envelope.

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

This method takes an optional query parameter that lets you specify whether changes made while the envelope 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 envelope was locked are discarded.

Related topics

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.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v2.1/accounts/string/envelopes/string/lock"
{  "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"}

Locks an envelope POST

This method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope. 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 an envelope) while the envelope is locked. If you do not provide the `lockToken` when accessing a locked envelope, 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 - [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)

Updates an envelope lock PUT

Updates the lock information for a locked envelope. You must include the `X-DocuSign-Edit` header as described in [EnvelopeLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/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" } ```