Quick Start

From zero to your first email in the queue in a few steps. The must-have is a verified domain in DNS, without it, send will not work.

In short

Verify a domain in DNS, proves you control the sender (noreply@yourdomain.com).
Send with subject and body (text and/or HTML) to up to 500 recipients per call.
Query, schedule, or cancel and get status via webhooks.

Context: Introduction. Scopes: API Key scopes.

Before you start

Key with email:domains:create, email:domains:list, and email:send (or admin scope in testing)
The from domain must be VERIFIED before send
Auth: Authorization: Bearer sk_live_... or x-api-key
Base URL: https://api.notifique.dev, use sk_test_... in Sandbox when getting started

In sandbox with sk_test_, the From domain does not need to be verified. With sk_live_, send to the workspace test destination (…@sandbox.notifique.dev) to intercept in the Sandbox inbox without real delivery. HTML preview and the compatibility checker are in the New email composer and inbox.

1. Verify domain

Two paths, pick what fits your integration:

1A, Via dashboard

Settings → Email → Add domain
Copy the DNS records (TXT/CNAME) to your domain provider
Click Verify until status is VERIFIED

1B, Via API

Register domain

POST /v1/email/domains
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "domain": "yourdomain.com"
}

Expected response: 200 with PENDING status and DNS records:

{
  "success": true,
  "data": {
    "id": "clxx123...",
    "domain": "yourdomain.com",
    "status": "PENDING",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "notifique._domainkey.yourdomain.com",
        "value": "p=MIGf..."
      }
    ],
    "createdAt": "2025-02-15T10:00:00.000Z"
  },
  "message": "Add the DNS record(s) above to your domain, then call the verify endpoint or use the Verify button in the dashboard."
}

Save the domain id for the verify step. Verify (call again after DNS propagates):

POST /v1/email/domains/:id/verify
Authorization: Bearer sk_live_xxxxx

DNS still pending, 200, not an HTTP error:

{
  "success": true,
  "verified": false,
  "code": "EMAIL_DOMAIN_DNS_PENDING",
  "message": "DNS records are not verified yet. Check your DNS provider and try again in a few minutes.",
  "data": { "id": "clxx...", "domain": "yourdomain.com", "status": "PENDING" }
}

Verified, 200:

{
  "success": true,
  "verified": true,
  "code": "EMAIL_DOMAIN_VERIFIED",
  "message": "Domain verified successfully.",
  "data": { "id": "clxx...", "domain": "yourdomain.com", "status": "VERIFIED" }
}

Codes and HTTP errors: Error responses.

2. Send email

With a VERIFIED domain, send to one or many recipients. to is always an array (up to 500).

POST /v1/email/messages
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "type": "email",
  "payload": {
    "subject": "Order confirmation",
    "html": "<p>Hello, your order is confirmed.</p>",
    "text": "Hello, your order is confirmed."
  }
}

Required in payload: subject and at least text or html. In from, put the display name before the email — what the recipient sees in their inbox.

Send with copies (CC and BCC)

Carbon copy (CC) is like adding colleagues to the same Outlook email: everyone sees who received it. Blind carbon copy (BCC) works the same, but other recipients cannot see who is on BCC. With cc or bcc, everyone receives one email. Without copies, each address in to gets a separate send — like mailing individual letters to each person.

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "cc": ["manager@example.com"],
  "bcc": ["audit@example.com"],
  "type": "email",
  "payload": {
    "subject": "Order #12345",
    "html": "<p>Please find the receipt below.</p>"
  }
}

Reply to another address (replyTo)

When the sender is noreply@..., the customer’s reply usually goes nowhere. Use replyTo to set where replies go — like leaving a note that says “reply at the front desk”.

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "replyTo": ["help@yourdomain.com"],
  "type": "email",
  "payload": {
    "subject": "Question about your order",
    "html": "<p>Reply to this email if you need help.</p>"
  }
}

Attachments

Up to 10 files, ~30 MB total. Send the file as base64 (content) or provide a public URL (path).

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "type": "email",
  "payload": {
    "subject": "Order receipt",
    "html": "<p>Please find the receipt attached.</p>"
  },
  "attachments": [
    {
      "filename": "receipt.pdf",
      "content": "JVBERi0xLjQK...",
      "contentType": "application/pdf"
    },
    {
      "filename": "logo.png",
      "path": "https://cdn.yourdomain.com/assets/logo.png",
      "contentType": "image/png"
    }
  ]
}

Email with links

Links in HTML work like in any email client. Use <a href="..."> in the body for action buttons, password resets, order tracking, and more.

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "type": "email",
  "payload": {
    "subject": "Reset your password",
    "html": "<p>Click <a href=\"https://app.yourdomain.com/reset?token=abc\">here</a> to reset your password. The link expires in 1 hour.</p>"
  }
}

Send with template

If you already have a workspace template with email enabled:

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "type": "template",
  "payload": {
    "templateId": "TEMPLATE_ID",
    "variables": { "name": "Maria", "orderId": "12345" }
  }
}

cc, bcc, replyTo, and attachments also work with templates — same pattern as free-form sends. Expected response: 202

{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 1,
    "messageIds": ["clemail1..."],
  }
}

Response includes messageIds.

Unverified from domain → 400 with DOMAIN_NOT_VERIFIED.

Options in options: priority (high, normal, low), category (transactional or marketing), webhook (URL and secret for this batch only). metadata belongs at the request root (not in options). Use headers for thread replies (In-Reply-To, References). Details in the API reference. RFC 8058 (one-click unsubscribe): by default, if the recipient is a workspace contact, Notifique injects List-Unsubscribe. For transactional email use "listUnsubscribe": false. Invalid topic → 400 INVALID_LIST_UNSUBSCRIBE_TOPIC. Guide: One-click unsubscribe.

3. Query, schedule, and cancel

List sent

GET /v1/email/messages?page=1&limit=20
Authorization: Bearer sk_live_xxxxx

Optional filters: fromDate, toDate, status, emailDomainId. Requires email:read. View one send

GET /v1/email/messages/:id
Authorization: Bearer sk_live_xxxxx

Schedule, include in the send body:

{
  "from": "Support <noreply@yourdomain.com>",
  "to": ["customer@example.com"],
  "type": "email",
  "payload": {
    "subject": "Reminder",
    "html": "<p>Content.</p>"
  },
  "schedule": {
    "sendAt": "2025-12-31T14:00:00.000Z"
  }
}

Cancel (QUEUED or SCHEDULED status):

POST /v1/email/messages/:id/cancel
Authorization: Bearer sk_live_xxxxx

Scope: email:cancel. Scheduled credits return to the workspace.

4. Avoid duplicates

Idempotency-Key header on POST. Repeats within 24 h do not create duplicate sends. See Security and reliability.

5. Webhooks (optional)

Configure email.sent, email.delivered, email.opened, email.clicked, email.failed, email.complained, and email.cancelled to track without polling. Guide: Webhook events.

All send types

In the API reference (Email tab), open Send email and pick an example in the playground: basic, copies, attachments, links, scheduled, template, and template with copies.

Next steps

Introduction: when to use and status lifecycle
Scopes: key permissions
Webhook events: real-time status
Error responses: HTTP codes and code

Email API

E-mail

Domínios

E-mails recebidos

Domains

In short

Before you start

1. Verify domain

1A, Via dashboard

1B, Via API

2. Send email

Send with copies (CC and BCC)

Reply to another address (replyTo)

Attachments

Email with links

Send with template

3. Query, schedule, and cancel

4. Avoid duplicates

5. Webhooks (optional)

All send types

Next steps

​In short

​Before you start

​1. Verify domain

​1A, Via dashboard

​1B, Via API

​2. Send email

​Send with copies (CC and BCC)

​Reply to another address (replyTo)

​Attachments

​Email with links

​Send with template

​3. Query, schedule, and cancel

​4. Avoid duplicates

​5. Webhooks (optional)

​All send types

​Next steps

In short

Before you start

1. Verify domain

1A, Via dashboard

1B, Via API

2. Send email

Send with copies (CC and BCC)

Reply to another address (replyTo)

Attachments

Email with links

Send with template

3. Query, schedule, and cancel

4. Avoid duplicates

5. Webhooks (optional)

All send types

Next steps