Notifications API · settings
Set who the organization's mail goes out as
PUT /settings/sender
Set who the organization's mail goes out as: senderName, the name recipients see, and accountsEmail, the one address every message's Reply-To names (and its From, once the address's domain is the organization's verified sending domain).
Appends notifications.sender-saved. Idempotent by content: saving the sender as it stands 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: saving the sender as it stands appends nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
notifications.sender-saved
What a fact is: Facts and the journal.
AI agent tool
No agent tool. Who the tenant's mail goes out as — its name and accounts email — is the owner's call in Settings › Notifications, not an agent's.
Connecting an agent: AI agents.
Example
curl -X PUT 'https://notifications.getmanifold.io/settings/sender' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"senderName": "Ridgeline Outdoor",
"accountsEmail": "accounts@ridgeline-outdoor.example"
}'const response = await fetch("https://notifications.getmanifold.io/settings/sender", {
method: "PUT",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"senderName": "Ridgeline Outdoor",
"accountsEmail": "accounts@ridgeline-outdoor.example"
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"senderName": "Ridgeline Outdoor",
"accountsEmail": "accounts@ridgeline-outdoor.example"
}{
"sender": {
"senderName": "Ridgeline Outdoor",
"accountsEmail": "accounts@ridgeline-outdoor.example"
},
"tracking": true,
"fromAddress": "\"Ridgeline Outdoor\" <notifications@send.getmanifold.io>",
"platformFromAddress": "notifications@send.getmanifold.io"
}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. | Send the same request again shortly. |
How refusals work everywhere: Errors.
Used in
- Send mail from your own domain, step 1: Name the sender
- Send text messages under your own name, step 1: Name the sender
- Design your own emails, step 1: Name the sender