headers object
template_data object
The template version this message was rendered from.
Whether the email was submitted with a live or a test API key. Test emails are simulated and never delivered.
Possible values: [live, test]
Arbitrary JSON metadata (up to 10KB).
tracking object
Override domain-level open tracking for this email.
Override domain-level click tracking for this email.
URL patterns to exclude from click tracking (e.g. "unsubscribe", "magic_link").
When the email is scheduled to be sent (ISO 8601).
Batch ID if this email was part of a batch send.
preflight_result object
Spam score from content analysis.
Recommended action based on spam score.
validation_errors object[]
Validation issues found during preflight.
The field that caused the error.
Human-readable description of the field error.
Machine-readable error code for this field.
Possible values: [pending, scheduled, sent, delivered, failed, cancelled]
events object[]
Timeline of email events (delivery, opens, clicks, bounces). Only populated on single email retrieval.
Email status at the time of this event.
When this event occurred.
Specific event type (e.g. opened, clicked, bounced).
Error details if delivery failed.
failure object
Why a failed email was not delivered. Present only on emails whose status is failed.
Why the email failed. suppressed means the recipient is on the suppression list, invalid_recipient means the address cannot receive mail, bounced means a receiving server refused the message, expired means delivery kept being deferred until the retry window ran out, attachment_too_large and attachment_unavailable mean an attachment could not be included, dkim_key_mismatch means the sending domain's DKIM record is missing or does not match its signing key, sending_restricted means sending from the workspace was restricted until the message expired, platform_error means the failure was on the Epostix side, and not_delivered means the message was not delivered for a reason that could not be attributed. New values may be added.
Possible values: [suppressed, invalid_recipient, bounced, expired, attachment_too_large, attachment_unavailable, dkim_key_mismatch, sending_restricted, platform_error, not_delivered]
Who is responsible for the failure. recipient means the address itself, sender means the message, the sending domain or the workspace, platform means Epostix, and unknown means it could not be determined.
Possible values: [recipient, sender, platform, unknown]
Number of tracked link clicks.
Number of tracked opens.
Milliseconds from creation to delivery.
{
"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",
"failure": {
"reason": "suppressed",
"fault": "recipient"
},
"click_count": 0,
"open_count": 0,
"delivery_time_ms": 0
}