Update a notification preference for a user

PATCH

/users/{userId}/notification-preferences/{topic}

Users

Sets a target user's subscription state for the given topic. When the caller is not the target user the audit log explicitly records the admin override (actorId is the caller, reasonDetails says 'Updated by an admin on behalf of the user'). Cedar gates this on users.manage upstream.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Notification preference updated successfully

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.aworld.cloud/dashboard/v1/users//notification-preferences/' \
--header 'x-external-user-id;' \
--header 'x-user-id;' \
--header 'Content-Type: application/json' \
--data '{
    "subscribed": true
}'

Response Example

{
    "topic": "LEARNING_UPDATES",
    "subscribed": true,
    "isDefault": true,
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-06-15 16:41:21

Get current user referral code

Reset a notification preference for a user