docusign.accounts.put-envelope-purge-configuration

An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.

Sets the envelope purge configuration for an account.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
purgeenvelopes	string	No	—	When true, purging is enabled.
redactpii	string	No	—	When true, the system also redacts personally identifiable information (PII). Note: To redact PII, you must also set the property removeTabsAndEnvelopeAttachments to true.
removetabsandenvelopeattachments	string	No	—	When true, the system also purges the tabs and attachments associated with the envelopes.
retentiondays	string	No	—	The number of days to retain envelope documents before purging them. This value must be a number between 0 and 999.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
purgeenvelopes	string	No	—	When true, purging is enabled.
redactpii	string	No	—	When true, the system also redacts personally identifiable information (PII). Note: To redact PII, you must also set the property removeTabsAndEnvelopeAttachments to true.
removetabsandenvelopeattachments	string	No	—	When true, the system also purges the tabs and attachments associated with the envelopes.
retentiondays	string	No	—	The number of days to retain envelope documents before purging them. This value must be a number between 0 and 999.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.accounts.put-envelope-purge-configuration",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}