Skip to content

DocuSign: Updates a bulk send list

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

← Esignature operations · Get started

Operation docusign.esignature_bulksendv2crud_putbulksendlist

Provider route: PUT /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"]["esignatureBulkSendV2CrudPutBulkSendList"]>[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.esignatureBulkSendV2CrudPutBulkSendList(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_put_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
bodyModelOptionalExpand Creates a bulk send list — response body

Referenced models: Creates a bulk send list — response body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a bulk send list — response body

Referenced models: Creates a bulk send list — response body

16 more schemas are linked from the tables above, on the schema pages.

Creates a bulk send list — response body
FieldTypePresenceDescription and constraints
$objectRootThis object contains the details for the bulk send list.
bulkCopiesarrayOptionalAn array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information.
bulkCopies[]ModelEach itemExpand Creates a bulk send list — response body — bulk Copies item
listIdstringOptionalThe GUID of the bulk send list.
namestringOptionalThe name of the bulk send list.

Referenced models: Creates a bulk send list — response body — bulk Copies item

Creates a bulk send list — response body — bulk Copies item
FieldTypePresenceDescription and constraints
$objectRootThis object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.
customFieldsarrayOptionalThe custom fields for this copy of the envelope.

**Note:** These custom fields must also be included in the original envelope or template that you want to send.
customFields[]ModelEach itemExpand Creates a bulk send list — response body — bulk Copies item custom Fields item
docGenFormFieldsarrayOptional
docGenFormFields[]ModelEach itemExpand Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item
emailBlurbstringOptionalThe email body for this copy of the envelope.
emailSubjectstringOptionalThe email subject line for this copy of the envelope.

For information about adding merge field information to the email subject,
see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/).

**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.
prefillTabsarrayOptionalPrefill tabs are tabs
that the sender can fill in
before the envelope is sent.
They are sometimes called
sender tags or pre-fill fields.


[Pre-Fill Your Own Document Fields][app]
describes how prefill tabs
work in the web application.


[Customize your envelopes with pre-fill fields][catblog]
shows how to use prefill tabs
in your application using the eSignature
SDKs.

[app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html
[catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
prefillTabs[]ModelEach itemExpand Creates a bulk send list — response body — bulk Copies item prefill Tabs item
recipientsarrayOptionalInformation about the recipients associated with this copy of the envelope.
recipients[]ModelEach itemExpand Creates a bulk send list — response body — bulk Copies item recipients item

Referenced models: Creates a bulk send list — response body — bulk Copies item custom Fields item, Creates a bulk send list — response body — bulk Copies item prefill Tabs item, Creates a bulk send list — response body — bulk Copies item recipients item, Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item

Creates a bulk send list — response body — bulk Copies item custom Fields item
FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.
namestringOptionalThe name of the custom field.
valuestringOptionalThe value of the custom field.
Creates a bulk send list — response body — bulk Copies item prefill Tabs item
FieldTypePresenceDescription and constraints
$objectRoot
initialValuestringOptionalThe original value of the tab.
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional
rowValuesarrayOptional
rowValues[]ModelEach itemExpand Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item row Values item
valuestringOptionalSpecifies the value of the tab.

Referenced models: Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item row Values item

Creates a bulk send list — response body — bulk Copies item recipients item tabs item
FieldTypePresenceDescription and constraints
$objectRootA tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.

For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.
initialValuestringOptionalThe initial value that you want to assign to the tab.
tabLabelstringOptionalThe label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.

Maximum Length: 500 characters.
Deletes recipients from a template — response body — seals item id Check Information Input
FieldTypePresenceDescription and constraints
$objectRootA complex element that contains input information related to a recipient ID check.
addressInformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input address Information Input
An object that specifies recipient address information and how it is displayed.
dobInformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input dob Information Input
An object that specifies recipient date of birth information and how it is displayed.
ssn4InformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input ssn4 Information Input
An object that specifies the last four digits of the recipient's Social Security Number (SSN).
ssn9InformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input ssn9 Information Input
An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

Referenced models: Deletes recipients from a template — response body — seals item id Check Information Input address Information Input, Deletes recipients from a template — response body — seals item id Check Information Input dob Information Input, Deletes recipients from a template — response body — seals item id Check Information Input ssn4 Information Input, Deletes recipients from a template — response body — seals item id Check Information Input ssn9 Information Input

Deletes recipients from a template — response body — seals item email Notification
FieldTypePresenceDescription and constraints
$objectRootSets custom email subject and email body for individual
recipients. **Note:** You must explicitly set `supportedLanguage`
if you use this feature.
emailBodystringOptionalThe body of the email message.
emailBodyMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `emailBody` property can be edited.
emailSubjectstringOptionalThe subject line for the email notification.
emailSubjectMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `emailSubject` property can be edited.
supportedLanguagestringOptionalThe language to use for the standard email format and signing view for a recipient.

For example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience.

**Note:** This setting affects only Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.

To retrieve the possible values, use the [Accounts::listSupportedLanguages][ListLang] method.

[ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/
supportedLanguageMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `supportedLanguage` property can be edited.

Referenced models: Updates a template document — response body — name Metadata

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