Emails

Cancel a batch

Cancel every still-cancelable message in a batch in one call. Messages that have already been sent are left untouched — only queued or scheduled ones are stopped. Check what remains cancelable first with Retrieve a batch. Requires the emails:send capability.

post/email/batches/{id}/cancel

Request

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

Response

The updated 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.