DocuSign icon

DocuSign

Send documents for eSignature and manage envelopes with DocuSign

Actions198

Envelope Lock → Get Lock

AI-generated

Summary

Retrieves the current lock information for a DocuSign envelope, identified by its envelope ID. Use it to check whether an envelope is locked before editing or updating it.

Inputs

  • Authentication — Credential type used for the request: JWT (Service Integration, the default) or OAuth2 (User Authorization).
  • Envelope ID (required) — ID of the envelope whose lock should be retrieved.

Output shape

The lock information for the envelope as returned by the DocuSign API, as a single item per input.

The source pack shows only the handler name (handleEnvelopeLockGet), not its body, so the exact response fields are not confirmed. DocuSign's lock response typically includes details such as lock owner, type, and expiry. If the envelope has no lock, the API may return an error or an empty lock. Errors are surfaced by the node's error handling.

Examples

Example 1: Check whether an envelope is already locked before updating its recipients.

Resource: Envelope Lock; Operation: Get Lock; Envelope ID: expression from a previous node, e.g. {{ $json.envelopeId }}.

Links

Discussion