BulkSend: createBulkSendRequest

This method initiates the bulk send process. It generates a bulk send request based on an existing bulk send list and an envelope or template.

Consider using the BulkSend::createBulkSendTestRequest method to test your bulk send list for compatibility with the envelope or template that you want to send first. To learn about the complete bulk send flow, see the Bulk Send overview.

If the envelopes were successfully queued for asynchronous processing, the response contains a batchId that you can use to get the status of the batch. If a failure occurs, the API returns an error message.

Note: Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.

This method returns the following errors:

Error code Description
BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as created.
BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients.
BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES Bulk sending list contains more than {0} copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists.
BULK_SEND_ENVELOPE_CANNOT_BE_NULL Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send.
BULK_SEND_BLOB_STORE_ERROR Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support.
BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later." .Try again later, or contact DocuSign Support to request a higher tier.
BULK_SEND_ENVELOPE_NOT_FOUND Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value.
BULK_SEND_LIST_NOT_FOUND Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value.
BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending.
BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope.
BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up.
BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details.
BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible.
BULK_SEND_DUPLICATE_RECIPIENT_DETECTED Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope.
BULK_SEND_ENVELOPE_HAS_NO_TABS Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending.
BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope.
BULK_SEND_TAB_DOES_NOT_MATCH Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match.
BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match.
BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope.
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both.

Request

HTTP request

POST /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

bulkSendListIdstring

The GUID of the bulk send list. This property is created after you post a new bulk send list.

Request Body

bulkSendRequest

Responses

CodeDescriptionReference
201

Successful response.

bulkSendResponse
400

Error encountered.

errorDetails

SDK Method

BulkEnvelopes::createBulkSendRequest

Definitions

bulkSendRequest

This object contains information about the envelope or template that you want to send in bulk.

envelopeOrTemplateIdstring

The GUID of the envelope or template that you want to send in bulk.

bulkSendResponse

The object contains the response to a bulk send request.

batchIdstring

A batch identifier that you can use to get the status of the batch.

envelopeOrTemplateIdstring

The GUID of the envelope or template that was sent.

errorDetails[array]

A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests.

errors[array]

A list of errors that occurred. This information is intended to be parsed by machine.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />