Emails

Retrieve a batch

Retrieve a batch and its live, per-status rollup (how many of its messages are queued, sent, delivered, bounced, and so on). The counts update as the batch progresses. Create a batch with Send a batch of emails, or stop its remaining messages with Cancel a batch. Requires the emails:read capability.

get/email/batches/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/batches/{id}
  • Auth: HTTP bearer

Response

The batch.

object'batch' required
idstring required
countinteger required
scheduled_atstring nullable required
created_atstring required
status_countsobject required

Live child counts keyed by status (e.g. { delivered: 98, failed: 2 }).

cancelableinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.