Before you start
You need:- A domain connected to your Deliveryman AI account that has finished setup and its initial warmup.
- An API key. To create one, go to Integrations in the dashboard, open Deliveryman API Keys and click Manage.
1
Send an email
Call Send Email with a The response includes the email’s If you send again from the same domain before its send interval has passed, you get
from, to, subject and either html_content or plain_text_content.from can be a full email address, or just a domain. With a domain, Deliveryman picks one of that domain’s email accounts for you.message_id. Save it. You use it to look the email up, to match webhook events, and to reply in the same thread. It’s also sent with the email in the X-Deliveryman-Message-Id header.202 with status: "scheduled" and a scheduled_for time instead. The email goes out on its own at that time, and you get a sent webhook. A scheduled email can’t be replied to until it has gone out. See Rate limits for details.Open tracking is off by default and click tracking is on. Set open_tracking and click_tracking to change that. Tracking only applies to HTML emails.2
Check the delivery status
Fetch the email with Retrieve Sent Email, or list recent emails with List Sent Emails.
status starts as queued and changes as the recipient’s mail server responds:The same response lists the email’s
opens, clicks, bounce and replies.3
Read replies
List Replies returns the conversations that got a reply, most recent first. Each one holds the email you sent and every reply received in its thread.To answer a reply, call Send Email again with the reply’s
message_id as reply_to_message_id. Your answer is threaded under the original conversation in the recipient’s mail client, and later replies show up in the same inbox thread. You still pass from, to and subject as usual.4
Find what you can send from
List Domains returns the domains connected to your account and whether each one can send right now.List Domain Emails returns the email accounts on a specific domain. Use it to pick a
from value instead of hardcoding one.5
Get events on your webhook
Instead of polling, add a webhook URL in the dashboard to get
sent, failed, open, click, bounce, unsubscribe and reply events as they happen. See Webhooks to set it up.Keep your list clean
- Use Verify Email to check that an address exists before you send to it.
- Bounced and unsubscribed addresses are added to your suppression list automatically, and emails to them are rejected with
422. You can also add and remove entries yourself.