AuralisDocs
OperationsNotifications

Clear the unread badge, for named notifications or all of them

Mark some notifications read, or all of them.

/v1/notifications/mark-readViewer
Operation id
mark_read
Access
Any workspace role can call this.
POST/v1/notifications/mark-read

Mark some notifications read, or all of them.

Send ids with the notifications to mark, or all: true to clear the whole unread list for this user in this workspace. Sending neither is refused with 400.

updated is how many rows actually changed, so marking something already read reports 0 rather than failing. An id belonging to someone else is ignored rather than refused, for the same reason.

This only affects the calling user. Marking a broadcast notification read does not mark it read for anyone else.

Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.

Authorisation: any workspace role, including viewer. Reads are open to every member.

Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the notifications:read scope, and the workspace role of the person who owns it must meet the floor above.

Authorization

AuthorizationBearer <token>

A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/notifications/mark-read" \  -H "Content-Type: application/json" \  -d '{}'
{}