Skip to main content
PUT
Update notification read status.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Query Parameters

notificationId
string

Required non-empty opaque notification identifier. No UUID, length, character, or default rule is declared.

Response

Returns the read-status update outcome; an already-read notification succeeds and unavailable notifications are reported in the envelope.

Outcome of marking the selected notification as read.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Notifications.ApiPutNotificationMarkAsReadResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.