Skip to content

Notification settings

The authenticated user’s push notification preferences.

Operation Method + path Token scope Role Notes
Show notification settings GET /me/notification_settings.json read or write Authenticated user Returns the current push preference state
Update notification settings PATCH /me/notification_settings.json write Authenticated user Toggles delivery without removing subscriptions
{
"push_notifications_enabled": true,
"push_subscription_count": 2
}

push_subscription_count is the number of devices currently subscribed for web push. Disabling notifications keeps subscriptions registered (so re-enabling is instant) but suppresses delivery.

GET /me/notification_settings.json
PATCH /me/notification_settings.json
{ "push_notifications_enabled": true }

Requires a write-scoped token. Returns 200 OK with the new state.

Code When
401 Missing token, or read token attempting a write