Upsert a preference

PUT

http://localhost:4002/rest/v1/notifications/preferences/{type}

Notifications

Last modified:2026-09-23 05:28:45

Maintainer:Not configured

Creates or updates the preference for one notification type. Only the channels sent are changed.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "push_enabled": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'http://localhost:4002/rest/v1/notifications/preferences/' \
--header 'X-Nexus-Key: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "push_enabled": false
}'

Responses

🟢200

application/json

The saved preference row

Bodyapplication/json

Example

{
    "resident_id": "string",
    "type": "follow_review",
    "push_enabled": true,
    "in_app_enabled": true,
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z"
}

🟠400BadRequest

🟠401Unauthorized

Modified at 2026-09-23 05:28:45

Mark notification as read

Create a subscription