Mark notification as read

PATCH

http://localhost:4002/rest/v1/notifications/{id}/read

Notifications

Last modified:2026-09-23 05:22:40

Maintainer:Not configured

Idempotent. If the notification is already read it is returned unchanged.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'http://localhost:4002/rest/v1/notifications//read' \
--header 'X-Nexus-Key: ' \
--header 'Authorization: Bearer <token>'

Responses

🟢200

application/json

The notification, with read_at set

Bodyapplication/json

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "resident_id": "string",
    "type": "follow_review",
    "title": "string",
    "body": "string",
    "data": {
        "property1": "string",
        "property2": "string"
    },
    "read_at": "2019-08-24T14:15:22.123Z",
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z"
}

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

Modified at 2026-09-23 05:22:40

List own preferences

Upsert a preference