Nudge Preferences
Mute or unmute nudges for your whole active account. This is an account-wide setting, not a per-user one.
While nudges are muted:
- List Nudges answers an empty list with
optout: true; - Get Nudge still returns a nudge by its
uuid; - the account's AI objectives are not evaluated.
There is no separate read call: the current setting is the optout field of List Nudges.
Permissions: requires settings:update on the active account. Refused while the account is suspended.
Request body
optout boolean Req
true mutes nudges, false unmutes them.Response (200 OK)
optout boolean
The value now set.
Errors
400 Bad Request
optout (bool) is required — the body is not valid JSON, or optout is missing, null or not a boolean.401 Unauthorized
Missing or invalid auth.
403 Forbidden
No active account selected, Not a member of this account, Insufficient permissions (no settings:update), or the account is suspended (code account_suspended).415 Unsupported Media Type
Content-Type must be application/json.500 Internal Server Error
Failed to update preference.Request — mute nudges
curl -X PUT "https://api.ngris.com/v1/account/nudges/preferences" \
-H "X-API-KEY: <your_api_key>" \
-H "Content-Type: application/json" \
-d '{"optout": true}'
Response — 200 OK
{
"optout": true
}