Skip to navigation

BulkSend Resource

View as Markdown

You can use bulk send lists send documents to a large number of recipients on a recurring basis. You can use a bulk send list to send up to 1,000 copies at a time.

After you create a bulk send list, it persists and can be reused and edited any number of times.

You can customize individual copies of the envelope. For example, you can customize the email notification and language and add personalized notes.

Requirements and limitations

  • Bulk send must be enabled for your account. To enable this feature, contact your Account Manager or Business Development representative.
  • You can include up to 1,000 bulk recipients in each request.
  • When you send an envelope with bulk recipients, envelopes are added to a bulk recipient queue and sent in a metered fashion. An account can have a total of 2,000 total envelopes in the queue at a time. If you reach this limit, you will get an error message. Wait and resend the envelope at a later time. If you hit queue limits often, contact your Account Manager to see about modifying the queue limits for your account.

Methods supported

MethodDescription
createBulkSendListPOST /restapi/v2.1/accounts/{accountId}/bulk_send_lists
Creates a bulk send list.
createBulkSendRequestPOST /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send
Creates a bulk send request.
createBulkSendTestRequestPOST /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test
Creates a bulk send test.
deleteBulkSendListDEL /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
Deletes a bulk send list.
getBulkSendBatchEnvelopesGET /restapi/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes
Gets envelopes from a specific bulk send batch.
getBulkSendBatchesGET /restapi/v2.1/accounts/{accountId}/bulk_send_batch
Returns a list of bulk send batch summaries.
getBulkSendBatchStatusGET /restapi/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
Gets the status of a specific bulk send batch.
getBulkSendListGET /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
Gets a specific bulk send list.
getBulkSendListsGET /restapi/v2.1/accounts/{accountId}/bulk_send_lists
Gets bulk send lists.
updateBulkSendBatchActionPUT /restapi/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}
Applies a bulk action to all envelopes from a specified bulk send.
updateBulkSendBatchStatusPUT /restapi/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
Updates the name of a bulk send batch.
updateBulkSendListPUT /restapi/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
Updates a bulk send list.

BulkSend properties

PropertyTypeDescription
bulkCopiesarrayAn 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.
listIdstringThe GUID of the bulk send list. This property is created after you post a new bulk send list.
namestringThe name of the bulk send list.