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.
The external account number (int) or account ID GUID.
Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (
When set to true, purging is enabled.
When set to true, the system also redacts personally identifiable information (PII).
Note: To redact PII, you must also set the property
When set to true, the system also purges the tabs and attachments associated with the envelopes.
The number of days to retain envelope documents before purging them. This value must be a number between
This object describes errors that occur. It is only valid for responses and ignored in requests.
The code associated with the error condition.
A brief message describing the error condition.