Returns a list of bulk send batch summaries
Returns a summary of bulk send batches.
Use the batch_ids query parameter to narrow the list of batches.
You must specify exactly one of the following query parameters to get back a list of batch summaries:
| Parameter | Description |
|---|---|
from_date | A valid UTC DateTime: 2016-01-01 |
batch_ids | A comma-separated list of batch IDs to query. |
If neither query parameter is provided, a high-level, account-wide, overall bulk send status report is returned.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Query Parameters
A comma-separated list of batch IDs to query.
The maximum number of results to return.
Use start_position to specify the number of results to skip.
Valid values: 1 to 100
Default: 100
The start date for a date range in UTC DateTime format.
Use this parameter to search for specific text.
The zero-based index of the result from which to start returning results.
Use with count to limit the number
of results.
The default value is 0.
The kind of results to collect. Must be one of:
- all
- failed
- sent
- queued
The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.
Note: If this property is null, the value defaults to the current date.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/bulk_send_batch"{ "batchSizeLimit": "string", "bulkBatchSummaries": [ { "action": "string", "actionStatus": "string", "batchId": "string", "batchName": "string", "batchSize": "string", "batchUri": "string", "failed": "string", "queued": "string", "sent": "string", "submittedDate": "string" } ], "bulkProcessQueueLimit": "string", "bulkProcessTotalQueued": "string", "endPosition": "string", "nextUri": "string", "previousUri": "string", "queueLimit": "string", "resultSetSize": "string", "startPosition": "string", "totalQueued": "string", "totalSetSize": "string"}Changes the status of an envelope transfer rule PUT
This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
Gets the status of a specific bulk send batch GET
Gets the general status of a specific bulk send batch such as: - number of successes - number pending - number of errors The `bulkErrors` property of the response object contains more information about the errors. ### Related topics - [How to bulk send envelopes](https://developers.docusign.com/docs/esign-rest-api/how-to/bulk-send-envelopes/)