DocuSign: Sets the envelope purge configuration for an account
DocuSign esignature.esignatureEnvelopePurgeConfigurationPutEnvelopePurgeConfiguration: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_envelopepurgeconfiguration_putenvelopepurgeconfiguration
Provider route: PUT /restapi/v2.1/accounts/{accountId}/settings/envelope_purge_configuration. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureEnvelopePurgeConfigurationPutEnvelopePurgeConfiguration"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureEnvelopePurgeConfigurationPutEnvelopePurgeConfiguration(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_envelope_purge_configuration_put_envelope_purge_configuration(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
body | Model | Optional | Expand Gets the envelope purge configuration for an account — response body |
Referenced models: Gets the envelope purge configuration for an account — response body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets the envelope purge configuration for an account — response body |
Referenced models: Gets the envelope purge configuration for an account — response body
Schemas
Section titled “Schemas”Gets the envelope purge configuration for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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`). |
purgeEnvelopes | string | Optional | When **true,** purging is enabled. |
redactPII | string | Optional | When **true,** the system also redacts personally identifiable information (PII). **Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.** |
removeTabsAndEnvelopeAttachments | string | Optional | When **true,** the system also purges the tabs and attachments associated with the envelopes. |
retentionDays | string | Optional | The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_envelopepurgeconfiguration_putenvelopepurgeconfiguration. Catalog operation: esignature:EnvelopePurgeConfiguration_PutEnvelopePurgeConfiguration. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.