DocuSign: Updates the name of a bulk send batch
DocuSign esignature.esignatureBulkSendV2BatchPutBulkSendBatchStatus: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_bulksendv2batch_putbulksendbatchstatus
Provider route: PUT /restapi/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}. 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"]["esignatureBulkSendV2BatchPutBulkSendBatchStatus"]>[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.esignatureBulkSendV2BatchPutBulkSendBatchStatus(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_batch_put_bulk_send_batch_status(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.bulkSendBatchId | string | Required within parent | |
body | Model | Optional | Expand Updates the name of a bulk send batch — request body — body |
Referenced models: Updates the name of a bulk send batch — 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 Updates the name of a bulk send batch — response body |
Referenced models: Updates the name of a bulk send batch — response body
Schemas
Section titled “Schemas”Updates the name of a bulk send batch — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of `getBulkSendBatchStatus` |
action | string | Optional | |
actionStatus | string | Optional | |
batchId | string | Optional | The batch ID. |
batchName | string | Optional | The batch name. |
batchSize | string | Optional | The number of of bulk envelopes submitted in the current batch |
bulkErrors | array | Optional | An array of error statuses. |
bulkErrors[] | Model | Each item | Expand Updates the name of a bulk send batch — response body — bulk Errors item |
envelopeIdOrTemplateId | string | Optional | The ID of the draft envelope or template that was used to create the batch. |
envelopesInfo | Model | Optional | Expand Updates the name of a bulk send batch — response body — envelopes Info |
envelopesUri | string | Optional | The URI to get all envelopes sent in the batch. |
failed | string | Optional | The number of envelopes that failed to process or send. |
mailingListId | string | Optional | The ID of the mailing list used to create the batch. |
mailingListName | string | Optional | |
ownerUserId | string | Optional | |
queued | string | Optional | The number of envelopes waiting in pending queue |
resendsRemaining | string | Optional | |
senderUserId | string | Optional | The ID of the sender. |
sent | string | Optional | The number of envelopes sent successfully. |
submittedDate | string | Optional | The timestamp of when the batch was submitted in ISO 8601 format. |
Referenced models: Updates the name of a bulk send batch — response body — envelopes Info, Updates the name of a bulk send batch — response body — bulk Errors item
Updates the name of a bulk send batch — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
batchName | string | Optional | The new name of the bulk send batch. This property is required. The maximum length of the string is 500 characters. |
Updates the name of a bulk send batch — response body — envelopes Info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
completed | string | Optional | |
correct | string | Optional | |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
declined | string | Optional | |
deleted | string | Optional | |
delivered | string | Optional | |
digitalSignaturesPending | string | Optional | |
sent | string | Optional | The number of entries with a status of `sent`. |
signed | string | Optional | |
timedOut | string | Optional | |
transferCompleted | string | Optional | |
voided | string | Optional |
Updates the name of a bulk send batch — response body — bulk Errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single bulk send error report. |
created | string | Optional | The timestamp of when the error occurred in ISO 8601 format. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorMessage | string | Optional | The error message generated during processing, if any. |
recipientEmails | array | Optional | An array of email addresses for the failed bulk envelope. Recipient email/info of the failed bulk envelope. |
recipientEmails[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_bulksendv2batch_putbulksendbatchstatus. Catalog operation: esignature:BulkSendV2Batch_PutBulkSendBatchStatus. 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.