BulkSendBatch
Returns a summary of bulk send batches.
View Specific Information
The server uses the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the server.
- BatchId supports the '=, IN' operators.
- DateToSearch supports the '=, <, <=, >, >=' operators.
- Status supports the '=' operator.
- UserId supports the '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM BulkSendBatch where batchid = '3b85e723-dee0-44db-ab3d-c45f5db88b6f';
SELECT * FROM BulkSendBatch where batchid in ('3b85e723-dee0-44db-ab3d-c45f5db88b6f','0afbac04-dc4a-4586-8740-7e05f658aa08');
SELECT * FROM BulkSendBatch where status = 'queued';
SELECT * FROM BulkSendBatch where datetosearch = '2017-01-02';
SELECT * FROM BulkSendBatch where datetosearch <= '2024-12-12';
SELECT * FROM BulkSendBatch where datetosearch < '2024-12-12';
SELECT * FROM BulkSendBatch where datetosearch >= '2017-01-02';
SELECT * FROM BulkSendBatch where datetosearch > '2017-01-02';
SELECT * FROM BulkSendBatch where userid = 'b3367191-5269-458b-bb21-c177a10b6d26';
Columns
| Name | Type | References | Description |
| BatchId [KEY] | String | The batch ID. | |
| BatchName | String | The name of the batch. | |
| BatchSize | String | The number of envelopes in the batch. | |
| BatchUri | String | The batch details URI. | |
| Failed | String | Number of envelopes that failed to send. | |
| Action | String | Action of batch. | |
| ActionStatus | String | Action status of batch. | |
| Queued | String | Number of envelopes pending processing. | |
| Sent | String | Number of envelopes that have been sent. | |
| SubmittedDate | Datetime | The time stamp of when the batch was created in ISO 8601 format. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| DateToSearch | Datetime | Date to search for a date range in UTC DateTime format.
The default value is 2016-01-01. | |
| Status | String | The kind of results to collect. Must be one of: all, failed, sent, queued
The allowed values are all, failed, sent, queued. | |
| UserId | String | The User ID. |