Novu

Novu Domains API

Used to manage your inbound email domains.

Documentation GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/domains List inbound-email domains · Novu List Domains for an Environment #

Ask an LLM

“Which inbound email domains are registered in my current environment?”

“Can I filter my inbound domains by part of the domain name?”

Tell an agent

List all inbound-email domains in this environment.

Find my inbound domains whose name contains {name}.

POST /v1/domains Register an inbound-email domain · Novu Create a Domain #

Ask an LLM

“How do I set up a new domain so it can receive inbound email?”

“What DNS records do I get back when I register a receiving domain?”

Tell an agent

Register {name} as a new inbound-email domain.

Add receiving domain {name} with metadata {data} and give me the DNS records to add.

GET /v1/domains/{domain} Get a domain's configuration and DNS records · Novu Retrieve a Domain by Name #

Ask an LLM

“How can I see the configuration and required DNS records for one of my domains?”

“Does looking up a domain re-check its DNS, or just show the stored status?”

Tell an agent

Show me the configuration for domain {domain}.

List the DNS records {domain} needs to have in place.

PATCH /v1/domains/{domain} Update a domain's metadata · Novu Update a Domain #

Ask an LLM

“How do I change the metadata attached to an inbound domain?”

“If I send new data for a domain, does it merge or replace the old metadata?”

Tell an agent

Replace the metadata on domain {domain} with {data}.

Update the optional fields on domain {domain}.

DELETE /v1/domains/{domain} Delete an inbound-email domain · Novu Delete a Domain #

Ask an LLM

“What happens to a domain's routes when I delete the domain?”

“How do I stop a domain from receiving inbound mail altogether?”

Tell an agent destructive · confirm first

Delete domain {domain} and all of its routes.

Remove {domain} so its inbound mail stops being processed.

POST /v1/domains/{domain}/verify Verify a domain's MX records · Novu Verify a Domain #

Ask an LLM

“I've added the MX records; how do I get Novu to re-check and verify my domain?”

“Can I refresh a domain's verification status from live DNS?”

Tell an agent

Verify domain {domain} against live DNS now.

Re-check the MX record status for {domain} and update its verification.

POST /v1/domains/{domain}/diagnose Diagnose inbound DNS problems · Novu Diagnose Inbound DNS for a Domain #

Ask an LLM

“Why isn't my domain receiving inbound email?”

“Can I check whether my domain's mail host is on a DNS blocklist or has an apex CNAME collision?”

Tell an agent

Run inbound DNS diagnostics for {domain} and tell me how to fix any issues.

Troubleshoot the MX setup on {domain}.

GET /v1/domains/{domain}/routes List a domain's routes · Novu List Routes for a Domain #

Ask an LLM

“Which addresses on my domain have inbound routes set up?”

“Can I find every route on a domain that points to a particular agent?”

Tell an agent

List all routes on domain {domain}.

Show the routes on {domain} that deliver to agent {agentId}.

POST /v1/domains/{domain}/routes Create an inbound mail route · Novu Create a Route #

Ask an LLM

“How do I forward mail sent to an address on my domain to a webhook?”

“Can I route inbound email for one address to an agent instead of a webhook?”

Tell an agent

Create a {type} route for {address}@{domain}.

Route mail sent to {address} on {domain} to agent {agentId}.

GET /v1/domains/{domain}/routes/{address} Get the route for an address · Novu Retrieve a Route by Address #

Ask an LLM

“Where does mail sent to a specific address on my domain get delivered?”

“How do I look up the wildcard catch-all route for a domain?”

Tell an agent

Show the route bound to {address}@{domain}.

Fetch the catch-all route on {domain} using address {address}.

PATCH /v1/domains/{domain}/routes/{address} Change where a route delivers · Novu Update a Route #

Ask an LLM

“How do I switch an existing address route from a webhook to an agent?”

“Can I rename the address on a route, or do I have to recreate it?”

Tell an agent

Point the existing route for {address}@{domain} at agent {agentId}.

Change the route type for {address} on {domain} to {type}.

DELETE /v1/domains/{domain}/routes/{address} Delete an inbound mail route · Novu Delete a Route #

Ask an LLM

“How do I stop processing inbound mail for one address without deleting the domain?”

“Can I remove a single route from my receiving domain?”

Tell an agent destructive · confirm first

Delete the route for {address}@{domain}.

Stop handling inbound mail to {address} on {domain}.

POST /v1/domains/{domain}/routes/{address}/test Send a test email through a route · Novu Test an Inbound Route #

Ask an LLM

“How can I test an inbound route with a fake email before going live?”

“Can I preview the payload a route would deliver without actually sending it?”

Tell an agent

Send a test email from {from} with subject {subject} through the route for {address}@{domain}.

Dry-run the route for {address} on {domain} with subject {subject} from {from}, setting dryRun to {dryRun}.

GET /v1/domains/{domain}/auto-configure Check if DNS auto-configuration is available · Novu Retrieve Auto-configuration Availability #

Ask an LLM

“Can Novu set up my domain's DNS records automatically through Domain Connect?”

“If automatic DNS setup isn't supported, which records do I have to add by hand?”

Tell an agent

Check whether DNS auto-configuration is available for {domain}.

Tell me which DNS records I must add manually for {domain} if Domain Connect is unavailable.

POST /v1/domains/{domain}/auto-configure/start Start DNS auto-configuration · Novu Start DNS Auto-configuration #

Ask an LLM

“How do I get a link that applies Novu's DNS records at my DNS provider for me?”

“Can I choose where my DNS provider sends me back after auto-configuration?”

Tell an agent

Start DNS auto-configuration for {domain}.

Generate the Domain Connect redirect for {domain} and return me to {redirectUri} afterwards.

Documentation

https://docs.novu.co/api-reference/overview

https://docs.novu.co/api-reference/overview

https://docs.novu.co/api-reference/overview#authentication

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/rate-limits/novu-rate-limits.yml

https://docs.novu.co/platform/quickstart/nextjs

Specifications

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/openapi/novu-domains-api-openapi.yml

Code Examples

https://github.com/novuhq/examples

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-trigger-event-request-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-trigger-event-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-bulk-trigger-event-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-subscriber-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-subscriber-request-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-bulk-subscriber-create-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-environment-request-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-update-environment-request-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-environment-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-topic-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-integration-request-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-update-integration-request-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-integration-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-message-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-workflow-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-update-workflow-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-workflow-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-layout-response-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-subscriber-payload-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-error-dto-schema.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-trigger-event-request-dto-structure.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-subscriber-response-dto-structure.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-workflow-response-dto-structure.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-message-response-dto-structure.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-topic-response-dto-structure.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-integration-response-dto-structure.json

Other Resources

https://api.novu.co/api

https://github.com/novuhq/novu-postman

https://www.npmjs.com/package/@novu/api

https://pypi.org/project/novu-py/

https://github.com/novuhq/novu-go

https://github.com/novuhq/php-novu

https://github.com/novuhq/novu-csharp

https://github.com/novuhq/novu-java

https://github.com/novuhq/novu-elixir

https://github.com/novuhq/novu-kotlin

https://github.com/novuhq/novu-ruby

https://github.com/novuhq/novu-rust

https://github.com/novuhq/novu-dotnet

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-trigger-event-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-trigger-event-bulk-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-broadcast-event-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-subscriber-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-bulk-create-subscribers-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-topic-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-add-subscribers-to-topic-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-environment-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-integration-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-workflow-response-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-list-messages-example.json

https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-error-response-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/novu:novu-domains-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Novu Domains API
  description: Novu REST API. Please see https://docs.novu.co/api-reference for more details.
  version: 3.15.0
  contact:
    name: Novu Support
    url: https://discord.gg/novu
    email: support@novu.co
  termsOfService: https://novu.co/terms
  license:
    name: MIT
    url: https://opensource.org/license/mit
servers:
- url: https://api.novu.co
- url: https://eu.api.novu.co
security:
- secretKey: []
tags:


# --- truncated at 32 KB (196 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/openapi/novu-domains-api-openapi.yml