Skip to content

Mark a notification read

POST
/account/notifications/{id}/read

Marks one of your unread notifications as read, recording the time of this call.

You need to be signed in; no capability is needed. Without a session cookie or bearer token that identifies you, the answer is 401, whether or not public mode is on. An id that isn’t a valid UUID gets a plain-text 400 before sign-in is checked. Any request body is ignored.

Only an unread notification of yours can be marked. If the notification doesn’t exist, isn’t yours or is already read, the answer is the same 404, so marking the same notification twice gets 404 the second time, even if you are retrying after a lost 204. When two calls arrive together to mark the same unread notification of yours, one gets 204 and the other 404. A read time, once set, doesn’t change. No capability lets you mark someone else’s notifications, system.admin included.

On 204 only the notification’s read_at is set, and your cached unread count is cleared. Server errors get a plain-text 500.

id
required
string format: uuid

The id of one of your notifications, from listMyNotifications.

The notification was unread and is now marked read.

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed