Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeLocks

Updates an envelope lock.

Updates the lock information for a locked envelope.

You must include the X-DocuSign-Edit header as described in EnvelopeLocks: create.

Use this method to change the duration of the lock (lockDurationInSeconds) or the lockedByApp string.

The request body is a full lockRequest object, but you only need to specify the properties that you are updating. For example:

{
  "lockDurationInSeconds": "3600",
  "lockedByApp": "My Application"
}
put/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request body

lockDurationInSecondsstring

The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.

lockedByAppstring

A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.

lockTypestring

The type of lock. Currently edit is the only supported type.

templatePasswordstring

The password for the template. If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the templatePassword to save the changes.

useScratchPadstring

When true, a scratchpad is used to edit information.

Response

Successful response.