What is it?
The public REST API of Hyo Mail. Your servers send transactional email, read the message log and sync contacts and conversions with JSON over HTTPS.
Send transactional email, read delivery events, and keep contacts and orders in sync from your own systems at api.hyonova.com.
The public REST API of Hyo Mail. Your servers send transactional email, read the message log and sync contacts and conversions with JSON over HTTPS.
Developers who send receipts, confirmations and account notices from their own product, and teams that sync contacts from another system.
The API is included in every plan. Each message uses one Mail credit; your plan sets no monthly allowance and no daily cap.
POST /mail/v1/send queues one message from a template with variables, or from a subject and HTML, and returns 202 with the message id.
GET /mail/v1/messages lists messages newest first, filtered by status, recipient, tag or date, with cursor pagination.
GET /mail/v1/messages/{id} returns a message with its delivery events.
GET and POST /mail/v1/contacts list contacts and create or update one by email, with its consent.
POST /mail/v1/conversions records an order or another conversion for campaign attribution.
GET /mail/v1/forms lists your active sign-up forms.
GET /mail/v1/me returns the company, the key's scopes and your limits.
GET /mail/v1/openapi.json returns the OpenAPI 3.0 document, without a key.
Verify your domain (DKIM, SPF and DMARC) and add a sender in Hyo Mail. Without one, sending answers 409 SENDER_NOT_VERIFIED.
In Mail › Automations › API keys, select mail.transactional.send and copy the key. It starts with hnm_ and is shown once.
POST to https://api.hyonova.com/mail/v1/send with Authorization: Bearer and your key, the recipient and a template or HTML.
Send an Idempotency-Key. Repeating the same call returns the first result instead of sending twice.
JSON errors with a code and a request id, and standard HTTP statuses such as 402 INSUFFICIENT_CREDITS.
Every response carries x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset.
A message that the email service permanently rejects gets its credit back.
mail.transactional.send, mail.events.read, mail.contacts.read, mail.contacts.write, mail.conversions.write, and mail.integrations.write for the WordPress plugin.
Sending answers 402 INSUFFICIENT_CREDITS and nothing is queued. Add credits and send again with a new idempotency key.
Yes. Send subject and html instead of templateId. Unsafe content is removed.
Read it with GET /mail/v1/messages/{id}, or subscribe to the delivered and bounced webhooks.
Start free, verify your domain and create your first API key.