Updates an envelope lock
Updates the lock information for a locked envelope.
You must include the X-DocuSign-Edit header
as described in
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"}Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The envelope's GUID.
Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Request Body
application/json
This request object contains information about the lock that you want to create or update.
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
The type of lock. Currently edit is the only supported type.
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.
When true, a scratchpad is used to edit information.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/envelopes/string/lock" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}Deletes an envelope lock DELETE
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](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/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 Parameter | Description | | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `save_changes` | When **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 - [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)
Gets the status of recipients for an envelope GET
Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. ### Related topics - [How to list envelope recipients](https://developers.docusign.com/docs/esign-rest-api/how-to/get-envelope-recipients/) - [How to retrieve ID Evidence events](https://developers.docusign.com/docs/idevidence-api/how-to/retrieve-idevidence-events/) - [How to retrieve ID Evidence media](https://developers.docusign.com/docs/idevidence-api/how-to/retrieve-idevidence-media/)