Update notification preferences

PUT

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

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

OperationId:UpdateNotificationPreferences

Upserts the user's per-category mute flags and returns the recomputed effective preferences. Also served on PATCH. Requires a token with scope_priv on the notificationpreference object, with the same self-or-administrator confinement as the read. Addressing the user=* domain-default row is restricted to administrators. The body is a map of category to a boolean enabled flag, accepted either wrapped in a preferences object or as a flat map. Category keys longer than 32 characters, and empty keys, are skipped. The write is an upsert keyed on domain, user, and category, so sending a subset updates only those categories.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The recomputed effective preferences.

Bodyapplication/json

🟠400Err400

🟠401Err401

🟠403Err403

🔴500Err500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/domains/acme.example.com/users/1001/notification-preferences' \
--header 'Content-Type: application/json' \
--data '{
    "preferences": {
        "voicemail": true,
        "queue_action": false
    }
}'

Response Example

200 - Success Example

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

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

Read notification preferences

Create notification (internal)