DocuSign icon

DocuSign

Send documents for eSignature and manage envelopes with DocuSign

Actions198

Envelope Purge → Purge Documents

AI-generated

Summary

Purges stored content from a DocuSign envelope at a chosen purge level (documents only, documents plus metadata, or documents, metadata and redacted content). The source pack shows only a stub for the handler, so the exact request is not visible.

Inputs

  • Authentication — Credential type used for the request: JWT (Service Integration, default) or OAuth2 (User Authorization).
  • Envelope ID (required) — ID of the envelope to purge.
  • Purge State (required) — Level of purge to apply: Documents Purged (default), Documents and Metadata Purged, or Documents and Metadata and Redact Purged.

Output shape

Presumably the DocuSign API response for the purge request, returned as an n8n item. The handler body (handleEnvelopePurge) is not included in the source pack, so the exact shape is not confirmed.

Purging is destructive and likely irreversible. The resource description says it purges document content from completed envelopes, so use it on completed envelopes. Errors from DocuSign are surfaced as node errors.

Examples

Example 1: Delete documents from a completed envelope after a retention period while keeping its metadata.

Envelope ID set to an expression like {{$json.envelopeId}}, Purge State = Documents Purged.

Example 2: Fully erase an envelope's documents and metadata for a data-deletion request.

Envelope ID from the previous node, Purge State = Documents and Metadata Purged, Authentication = JWT.

Links

Discussion