Skip to Content
Brandedmail 1.0 release 🎉
Getting Started

Getting Started

Welcome to Brandedmail. This guide walks you through the minimum setup so you can send your first branded email.

1. Create an API key

  1. Go to https://brandedmail.app/api-keys.
  2. Create a new API key.
  3. Store it safely as an environment variable, for example:
BRANDEDMAIL_API_KEY=your_api_key_here

You’ll use this API key as a Bearer token in all requests.

2. Add & verify your domains

Before sending, you should prove that you own the domains you want to send from.

  1. Visit https://brandedmail.app/domains.
  2. Add the domain you want to send from (for example yourcompany.com).
  3. Follow the DNS instructions shown in the dashboard.
  4. Wait until the domain is shown as verified.

Once verified, you can send from addresses like [email protected] with your brand applied.

No domain yet? You can still get started by sending from one of our subdomains, for example [email protected].
When you’re ready to fully white‑label your emails, come back and connect your own domain.

3. Choose how you want to send

You can send emails using:

  • Node.js SDK – easiest if you’re using Node/TypeScript.
  • Plain HTTP requests – works from any language or environment.
npm install @brandedmail/node
import Brandedmail from "@brandedmail/node";
 
const client = new Brandedmail(process.env.BRANDEDMAIL_API_KEY!);
 
await client.emails.sendHtml({
  from: "[email protected]",
  to: "[email protected]",
  subject: "Hello from Brandedmail",
  html: "<h1>Welcome</h1><p>This is your first branded email.</p>",
});

Plain HTTP request

curl https://api.brandedmail.app/emails/html \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Hello from Brandedmail",
    "html": "<h1>Welcome</h1><p>This is your first branded email.</p>"
  }'
await fetch("https://api.brandedmail.app/emails/html", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: `Bearer ${process.env.BRANDEDMAIL_API_KEY}`,
  },
  body: JSON.stringify({
    from: "[email protected]",
    to: "[email protected]",
    subject: "Hello from Brandedmail",
    html: "<h1>Welcome</h1><p>This is your first branded email.</p>",
  }),
});

4. Next steps

  • Read more about authentication and headers.
  • Explore templates in the backend to send reusable, fully branded layouts instead of raw HTML.
IndexResponses & Errors