DocuSign Momentum 2018DocuSign Momentum 2018

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).

Request

HTTP request

POST /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
201

Successful response.

EnvelopeLocks
400

Error encountered.

errorDetails

SDK Method

Envelopes::createLock

Definitions

errorDetails
lockRequest
userInfo
EnvelopeLocks

Examples

Generic JSON Request/Response
Generic XML Request/Response