> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# EnvelopeLocks Resource

The EnvelopeLocks resource provides methods that allow you to manage locks on an envelope.

You can lock the envelope, and set the time until the lock expires, to prevent users or recipients from accessing and changing the envelope.

Users must have envelope locking capability enabled to use these functions.

## Methods supported

| Method                                                                     | Description                                                                                        |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| [create](/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/create) | POST `/restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock` Lock an envelope.              |
| [delete](/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/delete) | DEL `/restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock` Deletes an envelope lock.       |
| [get](/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/get)       | GET `/restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock` Gets envelope lock information. |
| [update](/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/update) | PUT `/restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock` Updates an envelope lock.       |

## EnvelopeLocks properties

| Property                | Type         | Description                                                                                                                                                                                                                                |
| ----------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `errorDetails`          | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests.                                                                                                                                           |
| `lockDurationInSeconds` | string       | Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended. |
| `lockedByApp`           | string       | Specifies the friendly name of the application that is locking the envelope.                                                                                                                                                               |
| `lockedByUser`          | userInfo     | A complex type containing information about the user that has the Envelope or Template locked.                                                                                                                                             |
| `lockedUntilDateTime`   | string       | The datetime until the envelope lock expires.                                                                                                                                                                                              |
| `lockToken`             | string       | A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.                                                                                                                                       |
| `lockType`              | string       | The type of envelope lock. Currently "edit" is the only supported type.                                                                                                                                                                    |
| `useScratchPad`         | string       | Reserved for future use. Indicates whether a scratchpad is used for editing information.                                                                                                                                                   |


## API Docs

- EnvelopeLocks [Lock envelope](https://developers.docusign.com/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/create.md)
- EnvelopeLocks [Delete envelope lock](https://developers.docusign.com/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/delete.md)
- EnvelopeLocks [Get envelope lock information](https://developers.docusign.com/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/get.md)
- EnvelopeLocks [Update envelope lock](https://developers.docusign.com/docs/esign-rest-api/v2/reference/envelopes/envelopelocks/update.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.docusign.com/openapi.json)
- [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)