Emails

Send a batch of emails

Send up to 100 transactional emails in a single request. Validation is all-or-nothing: if any item is invalid the whole batch is rejected and nothing is queued, so you never end up with a partial send. Pass an Idempotency-Key header to make retries safe — the same key replays the original result instead of re-sending. The response returns a batch_id; track the batch's per-status rollup with Retrieve a batch and stop the rest of it with Cancel a batch. To send one email, use Send or schedule an email. Requires the emails:send capability.

post/email/batch

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/batch
  • Auth: HTTP bearer

Request body

OR

Response

Batch accepted.

object'list' required
batch_idstring required

Handle for GET / cancel on /email/batches/{id}.

status'queued' | 'scheduled' required
scheduled_atstring nullable required

Changes

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