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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Request Body

lockRequest

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeLocks
400

Error encountered.

errorDetails

SDK Method

Envelopes::updateLock

Definitions

errorDetails
lockRequest
userInfo
EnvelopeLocks

Examples

Generic JSON Request/Response
Generic XML Request/Response