Read notification preferences

GET

/domains/{domain}/users/{user}/notification-preferences

Last modified:2026-10-12 18:08:01

OperationId:ReadNotificationPreferences

Returns the user's effective per-category notification preferences, which are the domain default rows (stored under user=) overlaid with the user's own rows. Requires a token with scope_priv on the notificationpreference object. A caller who is not the target user and does not hold Office Manager, Call Center Supervisor, Super User, or Reseller scope receives a 403. The user= domain-default row is readable only by those administrator scopes. Preferences affect only what the feed returns and what the client renders; they are never enforced when a notification is created.

Request

Path Params

Responses

🟢200

application/json

The effective per-category preferences.

Bodyapplication/json

🟠400Err400

🟠401Err401

🟠403Err403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/domains/acme.example.com/users/1001/notification-preferences'

Response Example

200 - Success Example

{
    "preferences": {
        "voicemail": true,
        "queue_action": false,
        "security_alert": true,
        "fax": true,
        "shared_contact": true
    }
}

Modified at 2026-10-12 18:08:01

Hide all notifications for user

Update notification preferences