v1
latestSwagger 2.02026-07-134146194.6 MBReturns 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.
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<br> 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
Successful response.