Email

idstringrequired

fromstring

tostring[]

subjectstring

ccstring[]

bccstring[]

reply_tostring

textstring

htmlstring

headers object

property name*string

template_idstring

template_data object

property name*string

template_versioninteger

The template version this message was rendered from.

modestring

Whether the email was submitted with a live or a test API key. Test emails are simulated and never delivered.

Possible values: [live, test]

tagsstring[]

metadataobject

Arbitrary JSON metadata (up to 10KB).

tracking object

opensboolean

Override domain-level open tracking for this email.

clicksboolean

Override domain-level click tracking for this email.

clicks_excludestring[]

URL patterns to exclude from click tracking (e.g. "unsubscribe", "magic_link").

scheduled_atstring<date-time>

When the email is scheduled to be sent (ISO 8601).

batch_idstring

Batch ID if this email was part of a batch send.

preflight_result object

spam_scorenumber

Spam score from content analysis.

spam_actionstring

Recommended action based on spam score.

validation_errors object[]

Validation issues found during preflight.

Array [

fieldstringrequired

The field that caused the error.

messagestringrequired

Human-readable description of the field error.

codestringrequired

Machine-readable error code for this field.

]

statusstringrequired

Possible values: [pending, scheduled, sent, delivered, failed, cancelled]

created_atstring<date-time>required

updated_atstring<date-time>required

events object[]

Timeline of email events (delivery, opens, clicks, bounces). Only populated on single email retrieval.

Array [

statusstringrequired

Email status at the time of this event.

created_atstring<date-time>required

When this event occurred.

event_typestring

Specific event type (e.g. opened, clicked, bounced).

]

error_messagestring

Error details if delivery failed.

click_countinteger

Number of tracked link clicks.

open_countinteger

Number of tracked opens.

delivery_time_msinteger<int64>

Milliseconds from creation to delivery.

Email

{
  "id": "string",
  "from": "string",
  "to": [
    "string"
  ],
  "subject": "string",
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "reply_to": "string",
  "text": "string",
  "html": "string",
  "headers": {},
  "template_id": "string",
  "template_data": {},
  "template_version": 0,
  "mode": "live",
  "tags": [
    "string"
  ],
  "metadata": {},
  "tracking": {
    "opens": true,
    "clicks": true,
    "clicks_exclude": [
      "string"
    ]
  },
  "scheduled_at": "2024-07-29T15:51:28.071Z",
  "batch_id": "string",
  "preflight_result": {
    "spam_score": 0,
    "spam_action": "string",
    "validation_errors": [
      {
        "field": "string",
        "message": "string",
        "code": "string"
      }
    ]
  },
  "status": "pending",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "events": [
    {
      "status": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "event_type": "string"
    }
  ],
  "error_message": "string",
  "click_count": 0,
  "open_count": 0,
  "delivery_time_ms": 0
}