Returns all recipients’ delivery and open statuses for a given message UID.

Request Fields

These are passed in at the top level of the request.

Key Type Description
uid string Message to verify.

Request Example

{
  "api_key" : "PROJECT_API_KEY",
  "uid" : "uid_of_the_message"
}

Response 200 OK

{
  "response": {
    "status": "ok",
    "uid": "uid_of_the_message"
  },
  "data": {
    "message": {
      "id": "id_of_the_message"
    },
    "transmissions": {
      "test@example.org": {
        "status": "completed",
        "created_at": "2012-07-04 18:58:57",
        "failed_at": null,
        "opened_at": "2012-07-04 19:59:22",
        "result_code": "SMTP_250",
        "result_message": "2.0.0 OK 123456789 abc123"
      },
      "sample@example.com": {
        "status": "retry",
        "created_at": "2012-07-04 18:58:57",
        "failed_at": null,
        "opened_at": null,
        "result_code": null,
        "result_message": null
      },
      "bad@example.org": {
        "status": "failed",
        "created_at": "2012-07-04 18:58:57",
        "failed_at": "2012-07-04 18:58:59",
        "opened_at": null,
        "result_code": "SMTP_554",
        "result_message": "User does not exist"
      }
    }
  }
}

As email messages may take up to twenty-four hours to deliver or soft-fail, the delivery status of each email is not finalized until it’s either successfully delivered, or all attempts to do so have been exhausted.

As such it may be necessary to wait up to one day to get the final delivery status.

Response time is proportional to the number of recipients on a given message.

If polling this endpoint, we recommend syncing at most hourly.

If you have specific requirements beyond this, please email info@postageapp.com.