Skip to content

DocuSign: Deletes a bulk send list

DocuSign esignature.esignatureBulkSendV2CrudDeleteBulkSendList: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_bulksendv2crud_deletebulksendlist

Provider route: DELETE /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}. Alter supplies the connection’s credentials and routing.

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"]["esignatureBulkSendV2CrudDeleteBulkSendList"]>[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.esignatureBulkSendV2CrudDeleteBulkSendList(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_bulk_send_v2_crud_delete_bulk_send_list(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.bulkSendListIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets bulk send lists — response body

Referenced models: Gets bulk send lists — response body

Gets bulk send lists — response body
FieldTypePresenceDescription and constraints
$objectRootThis complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.
bulkListSummariesarrayOptionalAn array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user.
bulkListSummaries[]ModelEach itemExpand Gets bulk send lists — response body — bulk List Summaries item

Referenced models: Gets bulk send lists — response body — bulk List Summaries item

Gets bulk send lists — response body — bulk List Summaries item
FieldTypePresenceDescription and constraints
$objectRootThis object contains basic information about a bulk send list.
bulkSendListIdstringOptionalThe GUID of the bulk send list. This property is created after you post a new bulk send list.
createdByUserstringOptionalThe GUID of the user who created the bulk send list.
createdDatestringOptionalThe UTC DateTime that the bulk send list was created.
namestringOptionalThe name of the bulk send list.

SDK function policy ID: docusign.esignature_bulksendv2crud_deletebulksendlist. Catalog operation: esignature:BulkSendV2CRUD_DeleteBulkSendList. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.