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.

Request

HTTP request

POST /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.

}} />