Notifications API · push
Replace the caller's push preferences
PUT /me/push/preferences
Replace the caller's push preferences: the kinds that reach their devices (enabled, every other kind off) and, optionally, quiet hours (start and end on a 24-hour clock in timeZone; an end before the start runs overnight).
A push raised in quiet hours waits for their end. Appends notifications.push-preferences-saved. Idempotent by content: saving what is held appends nothing.
Access
Requires a signed-in session: a person's own devices and preferences: the route reads and changes only the caller's
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
Idempotent by content: saving what is held appends nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
notifications.push-preferences-saved
What a fact is: Facts and the journal.
AI agent tool
No agent tool. What reaches a person's phone and when it stays quiet is that person's choice under Settings › Push notifications, never an agent's.
Connecting an agent: AI agents.
Example
curl -X PUT 'https://notifications.getmanifold.io/me/push/preferences' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"enabled": [
"approval-request"
],
"quietHours": {
"start": "21:00",
"end": "07:00",
"timeZone": "Australia/Sydney"
}
}'const response = await fetch("https://notifications.getmanifold.io/me/push/preferences", {
method: "PUT",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"enabled": [
"approval-request"
],
"quietHours": {
"start": "21:00",
"end": "07:00",
"timeZone": "Australia/Sydney"
}
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"enabled": [
"approval-request"
],
"quietHours": {
"start": "21:00",
"end": "07:00",
"timeZone": "Australia/Sydney"
}
}{
"kinds": [
{
"kind": "approval-request",
"enabled": true
},
{
"kind": "staff-alert",
"enabled": false
}
],
"quietHours": {
"start": "21:00",
"end": "07:00",
"timeZone": "Australia/Sydney"
}
}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 |
|---|---|---|
PushNeedsPerson reason | The request was refused. reason says why. | The caller may not do this. Use a token whose roles allow it. |
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.