Quickstart

Your first email in about five minutes.

Your first email, in about five minutes. You need three things: an API key, a verified domain, and one HTTPS request.

1. Create an API key

Sign in to your workspace and open API keys. Create a key with the send scope. The secret is shown once — copy it somewhere safe before you close the dialog. It looks like this:

hme_yourkeyid_yoursecret

If you lose it, you cannot recover it. Revoke the old key and create a new one.

2. Verify the domain you want to send from

You can only send from a domain you have proven you control. Open Domains, add yourbusiness.com.au, and publish the DNS records it gives you at your domain's DNS provider. Then press recheck.

Most domains verify within a few minutes of the records going live. See Domains for what each record does, and for the one record you should not publish unless you want us to receive your mail as well.

3. Send

curl https://api.hamanimail.com/v1/send \
  -H "Authorization: Bearer hme_yourkeyid_yoursecret" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Your Business <hello@yourbusiness.com.au>",
    "to": "customer@example.com",
    "subject": "Welcome",
    "category": "transactional",
    "html": "<p>Thanks for signing up.</p>",
    "text": "Thanks for signing up."
  }'

A success looks like this:

{ "status": "queued", "messageId": "…", "idempotencyKey": "…" }

queued means we have accepted the message and will deliver it. Watch what happened to it in Emails in your workspace, or through the email log.

What to read next

If you want to	Read
Every field you can send	Emails
Scopes, key rotation and auth errors	Authentication
The DNS records and what each one does	Domains
Be told when a message is delivered or bounces	Webhooks
Reusable branded email	Templates
Every error this API can return	Errors

A note on test sending

There is no separate sandbox key. To test without touching a real person's inbox, send to an address you control. Bounces and complaints count against your sending reputation, so do not test against made-up addresses — see Sending responsibly.