Skip to content

Mark Read

POST
/users/{user_id}/notifications/{notification_id}/read
curl --request POST \
--url https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notifications/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/read

Mark one message read (set on open). Idempotent.

user_id
required
User Id
string format: uuid
notification_id
required
Notification Id
string format: uuid

Successful Response

Media typeapplication/json
NotificationRead
object
action_route
required
Any of:
string
body
required
Body
string
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
kind
required
Kind
string
read_at
required
Any of:
string format: date-time
summary
required
Summary
string
title
required
Title
string
updated_at
required
Updated At
string format: date-time
Examplegenerated
{
"action_route": "example",
"body": "example",
"created_at": "2026-04-15T12:00:00Z",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"kind": "example",
"read_at": "2026-04-15T12:00:00Z",
"summary": "example",
"title": "example",
"updated_at": "2026-04-15T12:00:00Z"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}