Skip to content

Mark a notification as read

POST
/v1/notifications/{notification_id}/read

Mark a single notification as read.

notification_id
required
Notification Id
string format: uuid

Successful Response

NotificationResponse
object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
category
required
Category
string
title
required
Title
string
message
required
Message
string
resource_type
required
Any of:
string
resource_id
required
Any of:
string format: uuid
is_read
required
Is Read
boolean
created_at
required
Created At
string format: date-time

Unauthorized – invalid or missing API key

Notification not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object