Novu

Novu Layouts API

Layouts are reusable wrappers for your email notifications.

Documentation GitHub OpenAPI

Operations 8

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

POST /v2/layouts Create a layout · Novu Create a Layout #

Ask an LLM

“How do I create a new shared layout for my emails?”

“Can I turn on translations when creating a layout?”

Tell an agent

Create a layout {name} with id {layoutId}.

Create layout {layoutId} named {name} with translations enabled: {isTranslationEnabled}.

GET /v2/layouts List email layouts · Novu List All Layouts #

Ask an LLM

“What layouts do I have available for my email templates?”

“Can I search layouts by name and sort the results?”

Tell an agent

List all my layouts.

Find layouts matching {query}.

PUT /v2/layouts/{layoutId} Update a layout · Novu Update a Layout #

Ask an LLM

“How do I rename a layout or change its content?”

“Can I update the control values on an existing layout?”

Tell an agent

Update layout {layoutId} with name {name}.

Save control values {controlValues} to existing layout {layoutId} named {name}.

GET /v2/layouts/{layoutId} Get a layout · Novu Retrieve a Layout #

Ask an LLM

“How do I fetch the details of one layout?”

“What content and settings does a specific layout have?”

Tell an agent

Show me layout {layoutId}.

Fetch the settings of layout {layoutId}.

DELETE /v2/layouts/{layoutId} Delete a layout · Novu Delete a Layout #

Ask an LLM

“How do I remove a layout I no longer use?”

“Can I delete a layout by its identifier?”

Tell an agent destructive · confirm first

Delete layout {layoutId}.

Remove the {layoutId} layout permanently.

POST /v2/layouts/{layoutId}/duplicate Duplicate a layout · Novu Duplicate a Layout #

Ask an LLM

“How do I copy an existing layout as a starting point for a new one?”

“Can I give the duplicated layout its own name and id?”

Tell an agent

Duplicate layout {layoutId} as {name}.

Make a copy of layout {layoutId} called {name}.

POST /v2/layouts/{layoutId}/preview Preview a layout · Novu Generate Layout Preview #

Ask an LLM

“How can I see what a layout will look like with sample data?”

“Can I preview a layout with different control values before saving?”

Tell an agent

Generate a preview of layout {layoutId}.

Render layout {layoutId} using sample payload {previewPayload}.

GET /v2/layouts/{layoutId}/usage See which workflows use a layout · Novu Get Layout Usage #

Ask an LLM

“Which workflows are using a particular layout?”

“Before deleting a layout, how do I check whether anything depends on it?”

Tell an agent

Show the workflows that use layout {layoutId}.

Check where layout {layoutId} is in use.

Documentation

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

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

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

https://artifacts.apis.io/novu/rate-limits/novu-rate-limits.yml

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

Specifications

https://artifacts.apis.io/novu/openapi/novu-layouts-api-openapi.yml

Code Examples

https://github.com/novuhq/examples

Schemas & Data

https://artifacts.apis.io/novu/json-schema/novu-trigger-event-request-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-trigger-event-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-bulk-trigger-event-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-subscriber-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-create-subscriber-request-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-bulk-subscriber-create-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-create-environment-request-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-update-environment-request-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-environment-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-topic-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-create-integration-request-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-update-integration-request-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-integration-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-message-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-create-workflow-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-update-workflow-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-workflow-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-layout-response-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-subscriber-payload-dto-schema.json

https://artifacts.apis.io/novu/json-schema/novu-error-dto-schema.json

https://artifacts.apis.io/novu/json-structure/novu-trigger-event-request-dto-structure.json

https://artifacts.apis.io/novu/json-structure/novu-subscriber-response-dto-structure.json

https://artifacts.apis.io/novu/json-structure/novu-workflow-response-dto-structure.json

https://artifacts.apis.io/novu/json-structure/novu-message-response-dto-structure.json

https://artifacts.apis.io/novu/json-structure/novu-topic-response-dto-structure.json

https://artifacts.apis.io/novu/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://artifacts.apis.io/novu/examples/novu-trigger-event-example.json

https://artifacts.apis.io/novu/examples/novu-trigger-event-bulk-example.json

https://artifacts.apis.io/novu/examples/novu-broadcast-event-example.json

https://artifacts.apis.io/novu/examples/novu-create-subscriber-example.json

https://artifacts.apis.io/novu/examples/novu-bulk-create-subscribers-example.json

https://artifacts.apis.io/novu/examples/novu-create-topic-example.json

https://artifacts.apis.io/novu/examples/novu-add-subscribers-to-topic-example.json

https://artifacts.apis.io/novu/examples/novu-create-environment-example.json

https://artifacts.apis.io/novu/examples/novu-create-integration-example.json

https://artifacts.apis.io/novu/examples/novu-workflow-response-example.json

https://artifacts.apis.io/novu/examples/novu-list-messages-example.json

https://artifacts.apis.io/novu/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-layouts-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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 Layouts 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 (115 KB total) ---
# Full source: https://artifacts.apis.io/novu/openapi/novu-layouts-api-openapi.yml