DocuSign icon

DocuSign

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

Actions341

Envelope Lock → Create

AI-generated

Summary

Create an envelope lock on a DocuSign envelope.

Inputs

  • authentication — DocuSign authentication method (OAuth2 or JWT).
  • category — API category to work with (e.g., envelopes, templates).
  • accountId (required) — DocuSign Account ID (GUID).
  • envelopeId (required) — ID of the envelope to lock.
  • lockDurationInSeconds — Lock duration in seconds (1-86400).
  • lockType — Lock type (currently only 'edit').
  • lockedByApp (required) — Application identifier that holds the lock.
  • useScratchPad — Whether to use a scratch pad for editing.

Output shape

a lock object representing the newly created envelope lock

Includes fields such as lockToken, lockExpiredSeconds, and echoToken; returns success/failure status.

Examples

Example 1: Lock an envelope for editing with default settings

authentication=oAuth2, category=envelopes, accountId=..., envelopeId=..., lockDurationInSeconds=300, lockType=edit, lockedByApp=n8n, useScratchPad=false

Example 2: Create a lock with a custom 60-second duration

authentication=oAuth2, category=envelopes, accountId=..., envelopeId=..., lockDurationInSeconds=60, lockType=edit, lockedByApp=n8n, useScratchPad=false

Links

Discussion