Notifications
In-app, email, SMS, and push notification preferences — per channel, per category — for every team member. This is separate from webhooks: notifications are for humans, webhooks are for your systems.
Get & update preferences
GET
/notifications/preferencesPATCH
/notifications/preferencesChannelsWhere a notification is delivered.
CategoriesWhat the notification is about.
A preference is one channel paired with one category, plus enabled. Every pair is independent, so a user can take security alerts by SMS while keeping marketing to email only.
json
{
"preferences": [
{ "channel": "EMAIL", "category": "PAYMENT", "enabled": true },
{ "channel": "SMS", "category": "MARKETING", "enabled": false }
]
}SECURITY notifications can't be disabled
The SECURITY category is mandatory — attempts to disable it are silently kept enabled server-side. Everything else defaults to on until a team member opts out.
Was this page helpful?