DocuSign: Creates a bulk send test
DocuSign esignature.esignatureBulkSendV2TestPostBulkSendTestRequest: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_bulksendv2test_postbulksendtestrequest
Provider route: POST /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test. 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"]["esignatureBulkSendV2TestPostBulkSendTestRequest"]>[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.esignatureBulkSendV2TestPostBulkSendTestRequest(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_bulk_send_v2_test_post_bulk_send_test_request(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 | |
path.bulkSendListId | string | Required within parent | |
body | Model | Optional | Expand Creates a bulk send test — request body — body |
Referenced models: Creates a bulk send test — request body — 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 Creates a bulk send test — response body |
Referenced models: Creates a bulk send test — response body
Schemas
Section titled “Schemas”Creates a bulk send test — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains the results of a bulk send test. |
canBeSent | boolean | Optional | When **true,** the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend: createBulkSendRequest][BulkSendRequest] method. **Note:** This property is only returned in responses and ignored in requests. [BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/ |
validationErrorDetails | array | Optional | Human-readable details about any validation errors that occurred. |
validationErrorDetails[] | string | Each item | |
validationErrors | array | Optional | A list of validation errors that were encountered during the bulk send test. **Note:** This information is intended to be parsed by machine. |
validationErrors[] | string | Each item |
Creates a bulk send test — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about the envelope or template that you want to send in bulk. |
batchName | string | Optional | The human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object. |
envelopeOrTemplateId | string | Optional | The GUID of the envelope or template that you want to send in bulk. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_bulksendv2test_postbulksendtestrequest. Catalog operation: esignature:BulkSendV2Test_PostBulkSendTestRequest. 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.