v1

latestSwagger 2.02026-07-134146194.6 MB

Accounts

Sets the envelope purge configuration for an account.

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.

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

Path parameters

accountIdstring required

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

Request body

purgeEnvelopesstring

When true, purging is enabled.

redactPIIstring

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

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

removeTabsAndEnvelopeAttachmentsstring

When 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.

Response

Successful response.