PATCH
Mark a notification read
Company space For: Everyone Conditions
  • Company routes only; no permission is needed.
  • The notification must be addressed to the signed-in actor (user-global or active profile, or the agent account).
What else happens
  • Sets read_at to the current time. A notification already read keeps its original read_at.
Part of Your account and notifications.

Authorizations

Authorization
string
header
required

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

Path Parameters

notification
string
required

Identifier of the in-app notification (27-character KSUID). It must be addressed to the signed-in actor.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, type, data, read_at, created_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource (only with response=resource).

id

Identifier of the notification (27-character KSUID).

type

Type of the notification, for example awaiting_approval or stock_alert, or a system notification type.

data
object

Notification payload; its keys depend on the type (for example order_id or asset_id, and an optional cta_url).

read_at

When the notification was marked read, ISO 8601; null while unread.

created_at

Date and time the record was created (ISO 8601, UTC).