Accounts

Gets the envelope purge configuration for an account

GET
/v2.1/accounts/{accountId}/settings/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 retrieves the current envelope purge configuration for your account.

Note: To use this method, you must be an account administrator.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/settings/envelope_purge_configuration"
{  "purgeEnvelopes": "string",  "redactPII": "string",  "removeTabsAndEnvelopeAttachments": "string",  "retentionDays": "string"}