Gets the status of a specific bulk send batch
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
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.
The batch ID.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/bulk_send_batch/string"{ "action": "string", "actionStatus": "string", "batchId": "string", "batchName": "string", "batchSize": "string", "bulkErrors": [ { "created": "string", "envelopeId": "string", "errorMessage": "string", "recipientEmails": [ "string" ] } ], "envelopeIdOrTemplateId": "string", "envelopesInfo": { "authoritativeCopy": "string", "completed": "string", "correct": "string", "created": "string", "declined": "string", "deleted": "string", "delivered": "string", "digitalSignaturesPending": "string", "sent": "string", "signed": "string", "timedOut": "string", "transferCompleted": "string", "voided": "string" }, "envelopesUri": "string", "failed": "string", "mailingListId": "string", "mailingListName": "string", "ownerUserId": "string", "queued": "string", "resendsRemaining": "string", "senderUserId": "string", "sent": "string", "submittedDate": "string"}Returns a list of bulk send batch summaries GET
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.
Updates the name of a bulk send batch PUT
Updates the name of a bulk send batch.