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.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Request Body
application/json
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).
When true, purging is enabled.
When true, the system also redacts personally identifiable information (PII).
Note: To redact PII, you must also set the property removeTabsAndEnvelopeAttachments to true.
When 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 0 and 999.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/settings/envelope_purge_configuration" \ -H "Content-Type: application/json" \ -d '{}'{ "purgeEnvelopes": "string", "redactPII": "string", "removeTabsAndEnvelopeAttachments": "string", "retentionDays": "string"}Gets the envelope purge configuration for an account GET
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.
Gets envelope notification defaults GET
This method returns the default settings for the email notifications that signers and senders receive about envelopes.