DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

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.

MethodDescription
get
GET /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Retrieves general information about the envelope lock.

If the call is made by the locked by user and the request has the same integrator key as original, then the X-DocuSign-Edit header and additional lock information is included in the response. This allows users to recover a lost editing session token and the X-DocuSign-Edit header.

update
PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Updates the lock duration time or update the lockedByApp property information for the specified envelope. The user and integrator key must match the user specified by the lockByUser property and integrator key information and the X-DocuSign-Edit header must be included or an error will be generated.

create
POST /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope.

Note: Users must have envelope locking capability enabled to use this function (userSetting canLockEnvelopes must be set to true for the user).

delete
DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Deletes the lock from the specified envelope. The X-DocuSign-Edit header must be included in the request.