Skip to content

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.

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 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_batch_put_bulk_send_batch_status(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.bulkSendBatchIdstringRequired within parent
bodyModelOptionalExpand 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Updates the name of a bulk send batch — response body

Referenced models: Updates the name of a bulk send batch — response body

Updates the name of a bulk send batch — response body
FieldTypePresenceDescription and constraints
$objectRootResult of `getBulkSendBatchStatus`
actionstringOptional
actionStatusstringOptional
batchIdstringOptionalThe batch ID.
batchNamestringOptionalThe batch name.
batchSizestringOptionalThe number of of bulk envelopes submitted in the current batch
bulkErrorsarrayOptionalAn array of error statuses.
bulkErrors[]ModelEach itemExpand Updates the name of a bulk send batch — response body — bulk Errors item
envelopeIdOrTemplateIdstringOptionalThe ID of the draft envelope or template that was used to create the batch.
envelopesInfoModelOptionalExpand Updates the name of a bulk send batch — response body — envelopes Info
envelopesUristringOptionalThe URI to get all envelopes sent in the batch.
failedstringOptionalThe number of envelopes that failed to process or send.
mailingListIdstringOptionalThe ID of the mailing list used to create the batch.
mailingListNamestringOptional
ownerUserIdstringOptional
queuedstringOptionalThe number of envelopes waiting in pending queue
resendsRemainingstringOptional
senderUserIdstringOptionalThe ID of the sender.
sentstringOptionalThe number of envelopes sent successfully.
submittedDatestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
batchNamestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
authoritativeCopystringOptionalWhen **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.**
completedstringOptional
correctstringOptional
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
declinedstringOptional
deletedstringOptional
deliveredstringOptional
digitalSignaturesPendingstringOptional
sentstringOptionalThe number of entries with a status of `sent`.
signedstringOptional
timedOutstringOptional
transferCompletedstringOptional
voidedstringOptional
Updates the name of a bulk send batch — response body — bulk Errors item
FieldTypePresenceDescription and constraints
$objectRootA single bulk send error report.
createdstringOptionalThe timestamp of when the error occurred in ISO 8601 format.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorMessagestringOptionalThe error message generated during processing, if any.
recipientEmailsarrayOptionalAn array of email addresses for the failed bulk envelope.

Recipient email/info of the failed bulk envelope.
recipientEmails[]stringEach item

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.

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.