Skip to main content

EmailListResponse

data object[]required
  • Array [
  • 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.

    failure object

    Why a failed email was not delivered. Present only on emails whose status is failed.

    reasonEmailFailureReasonrequired

    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]

    faultEmailFailureFaultrequired

    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]

    click_countinteger

    Number of tracked link clicks.

    open_countinteger

    Number of tracked opens.

    delivery_time_msinteger<int64>

    Milliseconds from creation to delivery.

  • ]
  • has_morebooleanrequired

    Whether there are more items available after this page.

    next_cursorstring

    Cursor to use as starting_after for the next page.

    EmailListResponse
    {
    "data": [
    {
    "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
    }
    ],
    "has_more": true,
    "next_cursor": "string"
    }