Skip to main content
GET
curl

Authorizations

X-Api-Key
string
header
required

Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Query Parameters

message_id
string
required

The message_id returned by Send Email. Works for scheduled emails too.

Required string length: 1 - 40

Response

Success

An email sent through the API, with its activity.

from
string
required

Email address the email was sent from.

message_id
string
required

Unique ID of the email, available as soon as it's accepted, including while it's scheduled. Use it to look the email up with Retrieve Sent Email, to match webhook events, and as reply_to_message_id to reply in the same conversation. It's also sent with the email in the X-Deliveryman-Message-Id header.

to
string
required

Recipient email address.

thread_message_id
string
required
read-only

message_id of the first email in this conversation. Equal to message_id unless this email was sent as a reply.

in_reply_to
string | null
required

message_id this email replied to, or null if it started a conversation.

subject
string
required

Subject line of the email.

html_content
string | null
required

HTML body, or null for plain text emails.

plain_text_content
string | null
required

Plain text body, or null for HTML emails.

opens
object[]
required
read-only

Opens of this email, oldest first. Empty when open tracking is off.

clicks
object[]
required
read-only

Link clicks in this email, oldest first. Empty when click tracking is off.

bounce
object | null
required

Bounce details, or null if the email didn't bounce.

replies
object[]
required
read-only

Replies received in the conversation this email started, oldest first. Always empty for emails sent as a reply. Their replies are listed on the conversation's first email.

open_tracking
boolean

Whether opens are tracked for this email.

click_tracking
boolean

Whether link clicks are tracked for this email.

status
enum<string>

Delivery status, updated as the mail server reports back. scheduled: waiting in the queue for your sending domain's next send slot. queued: accepted and waiting for the recipient's mail server to accept it. delivered: the recipient's mail server accepted it. failed: couldn't be delivered because of a problem on the sending side, or a scheduled email couldn't be sent (see failure_reason). The recipient is not suppressed. bounced: the recipient's server rejected it and the address was added to your suppression list. failed and bounced are final. A delivered email can still become bounced if a bounce arrives later.

  • scheduled - Scheduled
  • queued - Queued
  • delivered - Delivered
  • failed - Failed
  • bounced - Bounced
Available options:
scheduled,
queued,
delivered,
failed,
bounced
failure_reason
string | null

Why a scheduled email couldn't be sent, or null.

scheduled_for
string<date-time> | null

When a scheduled email will be handed to the mail server, or null if it was sent right away. ISO 8601, UTC.

sent_on
string<date-time> | null

When the recipient's mail server accepted the email. Null until delivery is confirmed. ISO 8601, UTC.

unsubscribed_on
string<date-time> | null

When the recipient unsubscribed through this email, or null.