EmailDetail

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/mailcheer-com/json-schema/mailcheer-com-email-detail-schema.json",
  "title": "EmailDetail",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mailcheer-com-openapi.json#/components/schemas/EmailDetail",
  "allOf": [
    {
      "$ref": "#/$defs/Email"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "sent",
            "delivered",
            "opened",
            "bounced",
            "complained",
            "failed"
          ],
          "description": "`queued` on acceptance, then `sent`, `delivered`, `opened`, `bounced`, `complained` or `failed` as our provider reports back. Expect a few seconds before `delivered`. With several addresses, it follows the recipients in `to` only: a copy (`cc`, `bcc`) that bounces does not change it — read `recipients` for each address."
        },
        "error": {
          "type": [
            "string",
            "null"
          ],
          "description": "The reason for the refusal, when `status` is `bounced`, `complained` or `failed`. `null` otherwise."
        },
        "tags": {
          "type": [
            "object",
            "null"
          ],
          "description": "The send's tags, after forbidden characters were rewritten.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "sent_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "delivered_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "opened_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "The first open, bots included."
        },
        "open_count": {
          "type": "integer",
          "description": "How many times the tracking pixel was loaded. Apple and Gmail preload images: this says attention, not readings."
        },
        "human_opened_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "The first open by a person — `null` as long as only bots have opened."
        },
        "track_opens": {
          "type": "boolean",
          "description": "Whether this email carried an open-tracking pixel. `false`: `opened_at` stays `null` because opens are not tracked, not because nobody opened."
        },
        "track_clicks": {
          "type": "boolean",
          "description": "Whether this email's links were tracked (`track_clicks`)."
        },
        "click_count": {
          "type": "integer",
          "description": "How many times a tracked link was clicked, bots included."
        },
        "clicked_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "The first click, bots included."
        },
        "human_clicked_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "The first click by a person — `null` as long as only bots have clicked."
        },
        "recipients": {
          "type": "array",
          "description": "Every address of the email — `to`, then `cc`, then `bcc` — with what Amazon reported for it. `status` above follows `to` only; here each copy has its own state. Opens are not per address: the tracking pixel is the same in every copy.",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "to",
                  "cc",
                  "bcc"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "queued",
                  "sent",
                  "delivered",
                  "bounced",
                  "complained",
                  "failed"
                ],
                "description": "`sent` until Amazon reports on this address, then `delivered`, `bounced` or `complained`. `queued` or `failed` while the email itself is."
              },
              "reason": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The bounce type Amazon reports (`Permanent`, `Transient`, `Undetermined`) when `status` is `bounced`. `null` otherwise."
              }
            }
          }
        }
      }
    }
  ],
  "$defs": {
    "Email": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier to pass back to `GET /api/v1/emails/{id}` to learn about delivery."
        },
        "object": {
          "type": "string",
          "const": "email"
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Always an array in the response, even if you passed a single address."
        },
        "subject": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}