Skip to content

Quickstart

Send your first email in 5 minutes.

1

Get an API key

Create an API key in your workspace settings. Your key will start with tm_live_ for production or tm_test_ for sandbox mode.

2

Send your first email

Use the POST /email/send endpoint to send a transactional email. Replace tm_live_abc123 with your actual API key.

curl -X POST https://api.topmail.so/api/v1/email/send \
  -H "Authorization: Bearer tm_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "recipient@example.com",
    "subject": "Hello from TopMail",
    "html": "<h1>Welcome!</h1><p>Your first email via the TopMail API.</p>",
    "from_email": "you@yourdomain.com",
    "from_name": "Your App"
  }'
{
  "data": {
    "sent": 1,
    "failed": 0,
    "skipped": 0,
    "total": 1,
    "results": [
      {
        "to": "recipient@example.com",
        "message_id": "01234567-89ab-cdef-0123-456789abcdef",
        "success": true
      }
    ]
  }
}
3

Check delivery status

Use the message_id from the response to check the delivery status of your email.

curl https://api.topmail.so/api/v1/email/MSG_ID/status \
  -H "Authorization: Bearer tm_live_abc123"

Next steps

Developer Docs - TopMail