Accounts: getEnvelopePurgeConfiguration

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.

Request

HTTP request

GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

envelopePurgeConfiguration
400

Error encountered.

errorDetails

SDK Method

Accounts::getEnvelopePurgeConfiguration

Definitions

envelopePurgeConfiguration

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 (retentionDays).

purgeEnvelopesstring

When set to true, purging is enabled.

redactPIIstring

When set to true, the system also redacts personally identifiable information (PII).

Note: To redact PII, you must also set the property removeTabsAndEnvelopeAttachments to true.

removeTabsAndEnvelopeAttachmentsstring

When set to true, the system also purges the tabs and attachments associated with the envelopes.

retentionDaysstring

The number of days to retain envelope documents before purging them. This value must be a number between 0 and 999.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />