Skip to main content
POST
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.

Body

from
string
required

Sender. Either a full email address from one of your connected domains (jane@draftss.com), or just the domain (draftss.com), in which case one of the domain's email accounts is picked for you. The domain must be connected to your account and ready to send.

to
string<email>
required

Recipient email address.

subject
string
required

Email subject line. Can't be empty.

Required string length: 1 - 998
Pattern: \S
html_content
string | null

HTML body of the email. Provide exactly one of html_content or plain_text_content.

plain_text_content
string | null

Plain text body of the email. Provide exactly one of html_content or plain_text_content. Open and click tracking are not available for plain text emails.

open_tracking
boolean
default:false

Track when the recipient opens the email. Only applies to HTML emails. Defaults to false.

click_tracking
boolean
default:true

Track clicks on links in the email. Only applies to HTML emails. Defaults to true.

reply_to_message_id
string | null

Send this email as a reply in an existing conversation. Pass the message_id of an email you sent, or of a reply you received (from Inbox or the reply webhook). The email is threaded under the original conversation in the recipient's mail client, and its replies show up in the same Inbox thread.

Maximum string length: 40

Response

Email Sent

The email that was sent or scheduled.

from
string
required

Email account the email was sent from. When from was a domain, this is the account picked.

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.

status
enum<string>
required

queued: handed to the mail server now (HTTP 201). scheduled: your sending domain's send interval hasn't passed yet, so the email waits in a queue and goes out at scheduled_for (HTTP 202).

  • queued - queued
  • scheduled - scheduled
Available options:
queued,
scheduled
subject
string
required

Subject line of the email.

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.