Notifications API · templates
Everything a template author needs
GET /email-templates/catalog
Everything a template author needs: the style the organization chose (absent until it chooses one) and the styles on offer (custom: the organization's layout, layoutTemplateId); each kind of email a template can be written for (invoice, quote, order-confirmation, purchase-order) with what sends it, the template data schema it renders and a fixed sample of that data, the organization's active template for it, and starterId, the starter it renders without one (the chosen style's, else classic); Manifold's starter templates — one per kind in each style, and layout-custom — with their whole source; and typings, the TypeScript declarations of @manifold/email.
A template is a TSX module in react-email's dialect: it exports subject (a string, or a function of the data), optionally preview, and the email as its default export — a function of the kind's template data returning react-email components (Html, Body, Container, Section, Row, Column, Heading, Text, Button, Link, Img, Hr, …) and plain HTML elements, imported from @manifold/email with the helpers money, date and plural (GET /email-templates/catalog answers the full declarations). It runs in a sandbox — no network, files, timers or other modules, 250 ms and 16 MB a render — and what it returns is held to the dialect: no script, event handler or class, links https:/http:/mailto:/tel:, images https:.
Access
Requires settings:read or notifications:read.
Any one of these scopes is enough.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
AI agent tool
Agents call this as notifications_get_email_template_catalog (Notifications: Email template kinds, starters and dialect), in the notifications toolset. It only reads.
Connecting an agent: AI agents.
Example
curl -X GET 'https://notifications.getmanifold.io/email-templates/catalog' \
-H "Authorization: Bearer $MANIFOLD_TOKEN"const response = await fetch("https://notifications.getmanifold.io/email-templates/catalog", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"style": "bold",
"styles": [
{
"style": "classic",
"name": "Classic",
"description": "A white card with your name as letterhead, every line and the totals."
},
{
"style": "bold",
"name": "Bold",
"description": "The figure that matters set large on a colour band, then the lines."
},
{
"style": "minimal",
"name": "Minimal",
"description": "A short plain letter: the figure, the date and the lines."
},
{
"style": "custom",
"name": "Custom",
"description": "Your own layout — the page, header and footer every email is drawn in."
}
],
"kinds": [
{
"kind": "invoice",
"description": "Sent to the customer when a tax invoice is issued for their order.",
"dataSchema": "InvoiceTemplateData",
"sample": {
"kind": "invoice",
"version": 2,
"shop": {
"name": "Ridgeline Outdoor",
"email": "accounts@ridgeline-outdoor.example"
},
"invoice": {
"number": "INV-1042"
}
},
"activeTemplateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a11",
"starterId": "invoice-bold"
}
],
"starters": [
{
"id": "invoice-classic",
"kind": "invoice",
"style": "classic",
"name": "Classic",
"description": "A white card with the shop's name as letterhead.",
"default": true,
"source": "import { Container, Heading, Text, money } from \"@manifold/email\";\nexport const subject = (data) => `Invoice ${data.invoice.number} from ${data.shop.name}`;\nexport default function Invoice(data) {\n return (\n <Container>\n <Heading>Thanks, {data.customer?.firstName ?? \"there\"}</Heading>\n <Text>{money(data.invoice.totals.totalCents, data.invoice.currency)} is due.</Text>\n </Container>\n );\n}\n"
}
],
"typings": "declare module \"@manifold/email\" { … }"
}The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web
page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: notifications-manager.openapi.json. Base URL https://notifications.getmanifold.io.
Errors
Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.
401
| Refusal | What it means | What to do |
|---|---|---|
Unauthorized reason | The token is missing, expired or not one Manifold issued. | Get a fresh token and send the call again. |
TokenAlreadyUsed tokenId | A single-use app token was already spent. | Mint a new token for this call. |
402
| Refusal | What it means | What to do |
|---|---|---|
SubscriptionRequired status | The organization's subscription has lapsed, so writes are refused. | An owner settles billing. Reads still work meanwhile. |
403
| Refusal | What it means | What to do |
|---|---|---|
TenantRequired userId | The token names no organization. | Choose the organization, then get a new token. |
ScopeRequired required | The token's roles do not grant the scope this call needs. | Ask an owner or admin for a role that grants it. |
409
| Refusal | What it means | What to do |
|---|---|---|
MirroredFromSource source | This area is fed by your source system until the organization goes live. | Make the change in the source system, or go live first. |
503
| Refusal | What it means | What to do |
|---|---|---|
RequestLogUnavailable tokenId, reason | The service could not record the request, so it did nothing. | Try again shortly. |
How refusals work everywhere: Errors.
Used in
- Design your own emails, step 2: Read the catalogue