DocuSign: Deletes clickwraps for an account
DocuSign click.clickClickwrapsDeleteClickwraps: arguments, response, policy and SDK examples.
← Click operations · Get started
Operation docusign.click_clickwraps_deleteclickwraps
Provider route: DELETE /clickapi/v1/accounts/{accountId}/clickwraps. 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["click"]["clickClickwrapsDeleteClickwraps"]>[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.click.clickClickwrapsDeleteClickwraps(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.click.click_clickwraps_delete_clickwraps(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 | |
query | object | Optional | Additional keys: not allowed |
query.clickwrapIds | string | Optional |
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 Deletes clickwraps for an account — response body |
Referenced models: Deletes clickwraps for an account — response body
Schemas
Section titled “Schemas”Deletes clickwraps for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwraps | array | Optional | |
clickwraps[] | Model | Each item | Expand Deletes clickwraps for an account — response body — clickwraps item |
Referenced models: Deletes clickwraps for an account — response body — clickwraps item
Deletes clickwraps for an account — response body — clickwraps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clickwrapId | string | Optional | The ID of the clickwrap. |
clickwrapName | string | Optional | The name of the clickwrap. |
deletionMessage | string | Optional | A message describing the result of deletion request. One of: - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted. |
deletionSuccess | boolean | Optional | **True** if the clickwrap was deleted successfully. **False** otherwise. |
status | string | Optional | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.click_clickwraps_deleteclickwraps. Catalog operation: click:Clickwraps_DeleteClickwraps. 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.