Docs

Email

Send receipts and newsletters from your own domain, with templates, tracking and unsubscribes handled for you.

1. Set up your sending domain

  1. Add the domain

    POST /v1/email/provision/domains with your domain. The response lists dns_records to add.

    { "domain": "dukafresh.co.ke" }

  2. Publish the DNS records

    Add each record (SPF, DKIM, DMARC and CNAME) at your DNS host. Changes can take a few hours to spread.

  3. Verify

    POST /v1/email/provision/domains/{id}/verify. When spf_verified, dkim_verified and dmarc_verified are true, sending_ready becomes true.

Tip: In a hurry? POST /v1/email/provision/domains/use-default lets you send from the shared talks domain while yours verifies.

2. Create templates

Save emails you send often with POST /v1/email/templates. Put fields like {{first_name}} in the subject or body and fill them per email with template_vars.

Check how it looks before it goes out: POST /v1/email/send-test sends a single preview using preview_data, without touching your contacts.

3. Send

POST /v1/email/sendOne email: receipts, password resets, alerts
POST /v1/email/send-bulkNewsletters and campaigns to a group, list or CSV

For campaigns, turn on track_opens and track_clicks to see who engaged.

Unsubscribes

People who unsubscribe are skipped automatically, and sending to them returns recipient_unsubscribed. Check someone with GET /v1/email/unsubscribes/{email}.

Warning: Only remove an unsubscribe (DELETE /v1/email/unsubscribes/{email}) when the person has clearly asked to hear from you again.

Business mailboxes

You can also create real mailboxes on your domain, like [email protected], with POST /v1/email/provision/domains/{domainId}/users, and app passwords for mail apps with POST /v1/email/provision/users/{userId}/app-passwords.

Was this page helpful?
Powered by StdioX Labs