Mail

Get a bulk send

The state of a batch: counts and every recipient as queued, sending, sent, delivered, bounced, complained or failed (with the reason). Delivery states arrive from the mail system a little after each send. Requires scope mail:send.

get/mailboxes/{address}/send-batch/{id}

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/send-batch/{id}
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

idstring required

The batch id returned by the send-batch call

Response

The batch

successboolean

Example response

{
  "success": true,
  "data": {
    "mailbox": "updates@yourdomain.com"
  }
}

Changes

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