Skip to main content
POST
Mark Notification As Read

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

notificationRecipientId
string<uuid>
required

Notification recipient identifier

Example:

"0197fa01-d2e2-70df-8fd3-9e22a345a196"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Inbox notification

notificationRecipientId
string<uuid>
required

Notification recipient identifier

Example:

"0197fa01-d2e2-70df-8fd3-9e22a345a196"

notificationId
string<uuid>
required

Notification identifier

Example:

"0197fa00-3e63-7f58-a878-7ef7ecfa9bc1"

recipientUserId
string<uuid>
required

Recipient user identifier

Example:

"0197a805-0910-7eb2-bae7-90a13df2a9b2"

status
enum<string>
required

Notification recipient status

Available options:
UNREAD,
READ,
ARCHIVED
Example:

"UNREAD"

notification
object
required

Notification

recipient
object
required

Recipient user

createdAt
string<date-time>
required

Created at

Example:

"2026-07-10T12:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-07-10T12:00:00.000Z"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

deletedBy
string<uuid> | null

Deleted by

Example:

null

deliveredAt
string<date-time> | null

Delivered at

Example:

null

readAt
string<date-time> | null

Read at

Example:

null

archivedAt
string<date-time> | null

Archived at

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null