Introduction

The Notix API sends and receives email, SMS and one-time codes, and manages your domains, contacts, broadcasts, automations and webhooks. This reference is built from the same route definitions the API serves, so a field listed here is a field the API accepts.

Base URL

Every endpoint lives under one base URL and speaks JSON over HTTPS.

https://app.usenotix.dev/api

Paths in this reference start with the version, so sending an email is POST https://app.usenotix.dev/api/v1/emails.

Authentication

Create an API key on the API keys page in the console. Send it as a Bearer token on every request.

Authorization: Bearer $NOTIX_API_KEY

Each key carries a permission that decides which endpoints it reaches. Authentication lists every rule.

Your first request

curl -X POST https://app.usenotix.dev/api/v1/emails \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Acme <receipts@acme.com>",
    "to": "maria@example.com",
    "subject": "Your receipt for order 4471",
    "html": "<p>Thanks for your order.</p>"
  }'

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

await notix.emails.send({
  from: "Acme <receipts@acme.com>",
  to: "maria@example.com",
  subject: "Your receipt for order 4471",
  html: "<p>Thanks for your order.</p>",
});

SDKs

You can call the API directly, or use an SDK.

The quickstart shows a first send step by step.

The OpenAPI document

The machine-readable document behind this reference is public and needs no key. Point a client generator, Postman or an AI assistant at it.

https://app.usenotix.dev/api/v1/openapi.json

Each operation carries x-notix-key-access, the key permission it needs.

The same document is also at usenotix.dev/openapi.json, and usenotix.dev/.well-known/api-catalog points tools at it.

How this reference is organised

Start with the pages that apply to every request:

• Authentication: keys, and what each permission reaches.
• Rate limits: the per second limit, the per minute and daily ceilings, and the send budget.
• Errors: the error envelope and every error code.
• Idempotency: retry a request without sending twice.
• Pagination: how list endpoints page.

Then there is one page per endpoint, grouped by area:

• Auth: check a key and read its limits.
• Emails: send, batch, reschedule and cancel email.
• Templates: your templates and the starter library.
• Domains: add, verify and manage sending domains.
• Contact books: the lists your contacts live in.
• Contacts: add, import, update and delete contacts.
• Segments: live groups of contacts inside a contact book.
• Inbound: received mail and the shared inbox.
• Broadcasts: create, review, schedule and report on broadcasts.
• One-time codes: send and check codes by email or SMS.
• SMS: send text messages and read their status.
• Automations: automated series of emails.
• Deliverability: check a message before you send it.
• Analytics: volume and reputation figures.
• Webhooks: manage webhooks and their call log.
• Billing: read your wallet, receipts, invoices, plan and usage.