DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Envelope Lock → Update

AI-generated

Summary

Update an existing envelope lock.

Inputs

  • authentication — Authentication method (OAuth2 or JWT Service Integration)
  • category — The API category to work with (e.g., envelopes, templates, account, etc.)
  • accountId (required) — The DocuSign Account ID (GUID). Find it in DocuSign Admin → API and Keys.
  • envelopeId (required) — The ID (GUID) of the envelope
  • lockDurationInSeconds — How long to hold the lock (default 5 minutes)
  • lockToken (required) — The lock token received when the lock was created (required for update/delete)

Output shape

an object representing the updated envelope lock

Includes lockToken and lockDurationInSeconds; on error returns a standard DocuSign error envelope.

Examples

Example 1: Lock an envelope for editing

Configure authentication (OAuth2), set category to 'envelopes', provide accountId and envelopeId, supply a valid lockToken and optionally lockDurationInSeconds, then call Update.

Example 2: Refresh lock duration

Keep the same authentication and lockToken, update only lockDurationInSeconds to extend the lock.

Example 3: Remove the lock after editing

Provide envelopeId and lockToken, optionally adjust lockDurationInSeconds, then invoke Update to finalize removal.

Links

Discussion