__INITIALS__
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 retrieves the current envelope purge configuration for your account.
Note: To use this method, you must be an account administrator.
GET /restapi/v2.1/accounts/{accountId}/settings/envelope_purge_configuration| Parameter Name | Value | Description |
|---|---|---|
| Path Parameters | ||
| accountId | string | The external account number (int) or account ID GUID. |
| Code | Description | Reference |
|---|---|---|
| 200 | Successful response. | envelopePurgeConfiguration |
| 400 | Error encountered. | errorDetails |
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 ( | ||
purgeEnvelopes | string | When set to true, purging is enabled. |
redactPII | string | When set to true, the system also redacts personally identifiable information (PII). Note: To redact PII, you must also set the property |
removeTabsAndEnvelopeAttachments | string | When set to true, the system also purges the tabs and attachments associated with the envelopes. |
retentionDays | string | 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. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |