Skip to navigation
Docusign eSignature REST APIEnvelopes

EnvelopeLocks Resource

View as Markdown

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

MethodDescription
createPOST /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock
Lock an envelope.
deleteDEL /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock
Deletes an envelope lock.
getGET /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/lock
Gets envelope lock information.
updatePUT /restapi/v2/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.
lockDurationInSecondsstringSets 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.
lockedByAppstringSpecifies the friendly name of the application that is locking the envelope.
lockedByUseruserInfoA complex type containing information about the user that has the Envelope or Template locked.
lockedUntilDateTimestringThe datetime until the envelope lock expires.
lockTokenstringA unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
lockTypestringThe type of envelope lock. Currently “edit” is the only supported type.
useScratchPadstringReserved for future use.

Indicates whether a scratchpad is used for editing information.