DocuSign icon

DocuSign

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

Actions341

Envelope → Update

AI-generated

Summary

Update an existing DocuSign envelope with specified fields such as email subject, status, and lock settings.

Inputs

  • authentication — Authentication method (OAuth2 or JWT) to use for the DocuSign API
  • category — API category selector; typically set to "envelopes" for envelope operations
  • envelopeId (required) — The GUID of the envelope to update
  • accountId (required) — DocuSign Account ID (GUID) where the envelope resides
  • emailSubject — Subject line for the email sent with the envelope
  • emailBlurb — Additional message body for the email
  • status — Change envelope status; values include "sent" or "voided"
  • voidedReason — Reason for voiding the envelope; required when status is set to "voided"
  • brandId — Brand ID to apply to the envelope
  • purgeState — Purge state for GDPR/CCPA compliance
  • messageLock — Lock the envelope to prevent further modifications
  • recipientsLock — Lock recipients to prevent further modifications

Output shape

a single updated envelope object

Only the provided fields are modified; unchanged fields remain as before. On error a DocuSign error response is returned.

Examples

Example 1: Void an envelope with a specific reason

Set status to "voided", provide voidedReason, envelopeId and accountId

Example 2: Send envelope with custom email subject and body

Set emailSubject and emailBlurb, leave other fields unchanged

Example 3: Prevent further changes to envelope and its recipients

Set messageLock and recipientsLock to "true", include envelopeId and accountId

Links

Discussion