Platform

Notification Preferences

Read and update the authenticated user notification preferences.

Notification Preferences

Notification preferences belong to the authenticated user and apply across all their organizations. Both endpoints require the OAuth profile scope.

Read preferences

GET /api/public/v1/users/me/notification-preferences
Authorization: Bearer ACCESS_TOKEN
{
  "digestFrequency": "Weekly",
  "newsletter": true
}

digestFrequency accepts Daily, Weekly, Biweekly, Monthly, or Never. Existing users who have not changed their preferences use Daily, and newsletter subscription defaults to true.

Update preferences

The update is partial. Omitted fields keep their current value.

PATCH /api/public/v1/users/me/notification-preferences
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "digestFrequency": "Monthly",
  "newsletter": false
}

Unknown fields, invalid frequencies, and non-boolean newsletter values return 400 Bad Request.