Notifications API · templates
Choose what a kind of email renders from now
PUT /email-templates/kinds/{kind}/active
Choose what a kind of email renders from now: one of the organization's templates for that kind (templateId), or — without one — Manifold's default.
Every message of the kind sent from then names the template version it went out with. Appends notifications.template-activated. 404 EmailTemplateNotFound; 409 EmailTemplateConflict for a template of another kind or an archived one. Idempotent by content: choosing what the kind already renders 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 what the kind already renders appends nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
notifications.template-activated
What a fact is: Facts and the journal.
AI agent tool
No agent tool. Which design every customer or supplier receives is the merchant's choice: an agent drafts, previews and tests a template, and the merchant makes it live in Settings › Notifications › Email templates.
Connecting an agent: AI agents.
Example
curl -X PUT 'https://notifications.getmanifold.io/email-templates/kinds/invoice/active' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"templateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a11"
}'const response = await fetch("https://notifications.getmanifold.io/email-templates/kinds/invoice/active", {
method: "PUT",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"templateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a11"
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"templateId": "etp_01a15a02-7c41-7a6e-9d10-3f6c2b8e4a11"
}{
"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"
}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. |
404
| Refusal | What it means | What to do |
|---|---|---|
EmailTemplateNotFound templateId | No such record in this organization. | Check the id in the path or the body. |
409
| Refusal | What it means | What 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
| Refusal | What it means | What 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
- Design your own emails, step 7: Make it what invoices send