Docmost Octri Preview
POST/notifications/mark-read

Mark specific notifications as read

Marks specified notifications as read for the authenticated user. Supply their UUIDs in notificationIds; omitting the field leaves notifications unchanged.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Options for marking notifications as read; all fields are optional.

notificationIdsarray<string>optional
Notifications to mark as read. Omitting it is a no-op.

2 status codes
200Returns a response payload confirming the notifications were marked as read.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
401Returned when the request is unauthenticated.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 401 is returned when the request is unauthenticated. Send valid credentials in the Authorization header. Each value in notificationIds must be a UUID.