Notifications API · templates

Choose the organization's email style

PUT /email-templates/style

Choose the organization's email style — classic, bold or minimal, a look Manifold's starters share, or custom, the organization's own layout (layoutTemplateId, a template of kind layout; absent to keep the one chosen before) drawn around each kind's content — so every kind without an active template of its own renders that style's starter from now; a kind with its own template keeps it.

Answers the catalogue as it then stands. Appends notifications.template-style-chosen. 404 EmailTemplateNotFound for an unknown layout; 409 EmailTemplateConflict for custom with no layout, a template that is not a layout or is archived, or a layout named with another style. Idempotent by content: choosing the style (and layout) already chosen appends nothing.

Access

Requires settings:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: choosing the style (and layout) already chosen appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

  • notifications.template-style-chosen

What a fact is: Facts and the journal.

AI agent tool

No agent tool. The look every customer's and supplier's email wears is the merchant's choice, made once in Settings › Notifications › Email templates; an agent reads it in notifications_get_email_template_catalog.

Connecting an agent: AI agents.

Example

curl
curl -X PUT 'https://notifications.getmanifold.io/email-templates/style' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "style": "custom",
  "layoutTemplateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a12"
}'
JavaScript (fetch)
const response = await fetch("https://notifications.getmanifold.io/email-templates/style", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "style": "custom",
    "layoutTemplateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a12"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "style": "custom",
  "layoutTemplateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a12"
}
Response · 200 · application/json
{
  "style": "custom",
  "layoutTemplateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a12",
  "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-custom"
    }
  ],
  "starters": [],
  "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

RefusalWhat it meansWhat 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

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat 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.

404

RefusalWhat it meansWhat to do
EmailTemplateNotFound templateId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
EmailTemplateConflict templateId, reason The request was refused. reason says why.Nothing changed. Read the record, then decide.
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

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.

Used in