Skip to content

Mark a single notification as read

POST
/v1/users/me/notifications/{id}/read
curl --request POST \
--url https://example.com/v1/users/me/notifications/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/read \
--header 'Authorization: Bearer <token>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
id
required
string format: uuid
X-Tenant-ID
required
string format: uuid

OK

Media type application/json
object
id
required
string format: uuid
event_type
required
string
title
required
string
body
required
string
resource_type
string
nullable
resource_id
string format: uuid
nullable
read_at
string format: date-time
nullable
created_at
required
string format: date-time
Example generated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"event_type": "example",
"title": "example",
"body": "example",
"resource_type": "example",
"resource_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"read_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z"
}

Unauthorized

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Not Found

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}