Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Daniel-Stojanovski/finkiopendesk/llms.txt

Use this file to discover all available pages before exploring further.

Two endpoints let you update read status within the notification system. You can mark a single event as read — useful when a user opens a specific comment — or mark every event in a group as read at once, which is the typical action when a user opens a notification panel and views a full thread. Both endpoints are idempotent: calling them on an already-read event or group has no observable effect.
Both endpoints are publicly accessible. No Authorization header is required.

Mark a single event as read

POST /api/notifications/event//read

Sets statusRead to true for the specified notification event. Use this when you know the exact event the user has seen (for example, after they navigate to the linked comment).
POST https://finkiopendesk-be.onrender.com/api/notifications/event/{eventId}/read

Path parameters

eventId
string
required
The notificationEventId of the event to mark as read. Retrieve this value from the events array returned by GET /api/notifications/{userId}.

Response

Returns 204 No Content with an empty body on success.

Example

curl -X POST \
  "https://finkiopendesk-be.onrender.com/api/notifications/event/11223344-5566-7788-99aa-bbccddeeff00/read"

Mark all events in a group as read

POST /api/notifications/group//read

Sets statusRead to true for every notification event that belongs to the specified group. This is the correct call when a user dismisses or views all notifications in a group at once, because it avoids issuing one request per event.
POST https://finkiopendesk-be.onrender.com/api/notifications/group/{groupId}/read

Path parameters

groupId
string
required
The notificationGroupId of the group whose events to mark as read. Retrieve this value from GET /api/notifications/{userId}.

Response

Returns 204 No Content with an empty body on success.

Example

curl -X POST \
  "https://finkiopendesk-be.onrender.com/api/notifications/group/f7e6d5c4-b3a2-1098-fedc-ba9876543210/read"

After calling either endpoint, refresh the notification list via GET /api/notifications/{userId} to see the updated statusRead values and the recalculated unreadCount on the affected group.

Build docs developers (and LLMs) love