> 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

Envelope locks allow you to manage locks on an envelope.

To prevent users from changing an envelope while another user is
modifying it, you can lock the envelope and set the time until
the lock expires.

To use envelope locks, the user must have envelope locking capability enabled.

### Related topics

* [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)

## Methods supported

| Method                                                                  | Description                                                                                          |
| ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| [create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create) | POST `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock` Locks an envelope.             |
| [delete](/docs/esign-rest-api/reference/envelopes/envelopelocks/delete) | DEL `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock` Deletes an envelope lock.       |
| [get](/docs/esign-rest-api/reference/envelopes/envelopelocks/get)       | GET `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock` Gets envelope lock information. |
| [update](/docs/esign-rest-api/reference/envelopes/envelopelocks/update) | PUT `/restapi/v2.1/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       | The number of seconds until the lock expires when there is no activity on the envelope. The default value is 300 seconds. The maximum value is 1,800 seconds. The lock duration can be extended. |
| `lockedByApp`           | string       | The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.                                |
| `lockedByUser`          | userInfo     | A complex type containing information about the user that has the envelope or template locked.                                                                                                   |
| `lockedUntilDateTime`   | string       | The date and time that the lock expires.                                                                                                                                                         |
| `lockToken`             | string       | A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.                                                             |
| `lockType`              | string       | The type of lock. Currently `edit` is the only supported type.                                                                                                                                   |
| `useScratchPad`         | string       | When **true,** a scratchpad is used to edit information.                                                                                                                                         |


## API Docs

- EnvelopeLocks [Lock envelope](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/create.md)
- EnvelopeLocks [Delete envelope lock](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/delete.md)
- EnvelopeLocks [Get envelope lock information](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/get.md)
- EnvelopeLocks [Update envelope lock](https://developers.docusign.com/docs/esign-rest-api/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)