Skip to navigation
Docusign eSignature REST APIEnvelopes

EnvelopeLocks Resource

View as Markdown

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.

Methods supported

MethodDescription
createPOST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Locks an envelope.
deleteDEL /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Deletes an envelope lock.
getGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Gets envelope lock information.
updatePUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Updates an envelope lock.

EnvelopeLocks properties

PropertyTypeDescription
errorDetailserrorDetailsThis object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringThe 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.
lockedByAppstringThe 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.
lockedByUseruserInfoA complex type containing information about the user that has the envelope or template locked.
lockedUntilDateTimestringThe date and time that the lock expires.
lockTokenstringA unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
lockTypestringThe type of lock. Currently edit is the only supported type.
useScratchPadstringWhen true, a scratchpad is used to edit information.