Quickstart

Two paths to your first send. Pick the one that matches what you’re trying to do today.

Pick your path

Path A — Try in 30 seconds

Get a bx_preview_… key and send a starter template. No signup, no DNS, no waiting.

1. Get your free key

Open the developers page and look for the Get your free API key widget at the top.

1. Enter your email address
2. Open the verification email and click the confirm link
3. Your bx_preview_… key appears on the next screen — copy it now, the full value is shown only once

export BRIXUS_API_KEY=bx_preview_your_key_here

2. Send your first email

1curl -X POST https://app.brixus365.com/api/v1/emails \
2-H "X-API-Key: $BRIXUS_API_KEY" \
3-H "Content-Type: application/json" \
4-d '{
5  "to": "you@example.com",
6  "starterTemplate": "welcome",
7  "variables": { "name": "Friend", "app_name": "My App" }
8}'

You’ll get back a messageId and status: "queued":

{
  "messageId": "fd92bd3f-969a-4ff6-87dc-a8b0a16e0297",
  "status": "queued",
  "from": "noreply@brixus365.dev"
}

Check your inbox. The email arrives within a few seconds.

What you can and can’t do on Path A

When you hit any of those limits, move to Path B — same API, more capability, on a Standard or Enterprise plan.

Path B — Build something real

Signup itself is free and gets you the dashboard, custom sending domains, and Spark campaigns you can build and send from the dashboard. Raw HTML sends, batch send, and the SMTP relay run on a live API key, which requires a Standard or Enterprise plan (see the checklist below). Setup takes ~10 minutes (mostly DNS records for domain verification).

Setup checklist

Path B has a 4-step setup before your first send works. Each step is described in detail in Before you send — here’s the summary:

Send your first production email

Once setup is complete, the same code as Path A works — just with your bx_live_… key. Sender will be your default verified address:

curl -X POST https://app.brixus365.com/api/v1/emails \
  -H "X-API-Key: bx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "customer@example.com",
    "starterTemplate": "welcome",
    "variables": { "name": "Alice", "app_name": "Acme" }
  }'

Response:

{
  "messageId": "dceaaa96-a806-43d2-ac2d-8396bbd3188a",
  "status": "queued",
  "from": "you@your-verified-domain.com"
}

What you can do on Path B

• Send via starter templates, your own saved templates, or raw HTML
• Send batches of up to 100 messages in one request
• Use the SMTP relay with any mail library (Nodemailer, PHPMailer, MailKit, etc.)
• Run Spark campaigns in the dashboard — drag-and-drop builder, automations, segments, analytics
• 15,000 sends/month and up on the Standard plan (required to create a live key), more on higher tiers

What’s next

Stuck? Email support@brixus365.com — we read every message.