Skip to main content
Two endpoints are available for marking notifications as read: one for a specific notification by ID, and one that clears all unread notifications at once. Both require only an Authorization header — no request body is needed.

​
Mark a single notification as read

PATCH /v1/notifications/:id/read
Marks one notification as read. Scoped to the authenticated user — users cannot mark another user’s notifications.

​
Headers

​
Authorization
string
required
Bearer token. Format: Bearer <token>

​
Path parameters

​
id
string
required
The ID of the notification to mark as read.

​
Response

​
success
boolean
true on a successful update.

​
Example

curl --request PATCH \
  --url https://api.nyotaimara.com/v1/notifications/ntf_01j9.../read \
  --header 'Authorization: Bearer <token>'

{
  "success": true
}

​
Mark all notifications as read

PATCH /v1/notifications/read-all
Marks every unread notification for the authenticated user as read in a single operation. Useful for a “mark all as read” button.

​
Headers

​
Authorization
string
required
Bearer token. Format: Bearer <token>

​
Response

​
success
boolean
true once all notifications have been updated.

​
Example

curl --request PATCH \
  --url https://api.nyotaimara.com/v1/notifications/read-all \
  --header 'Authorization: Bearer <token>'

{
  "success": true
}