Mark Notification Seen
Beta/v1/messaging/notifications/{id}/actions/seenIdempotent with Idempotency-Key header. Learn more
Marks a notification as seen.
idstringNotification ID.
include[]optional arrayenumValues:senderresourceSub-objects to expand in the response. When omitted, sub-objects are returned as null.
idstringNotification ID.
objectstringenumValues:notificationResource type identifier.
categorystringenumValues:chat.messagechat.mentionchat.addedThe kind of event this notification represents.
The set is open-ended and may grow over time. Common first-party categories are:
chat.message: a new message in a conversation.chat.mention: a direct @mention, delivered even when the conversation is muted.chat.added: the user was added to a conversation.order.updated: an order the user is involved with changed.agent.run_completed: an agent run the user triggered finished.agent.alert: an agent raised an alert during a run.system.broadcast: a targeted system message.
titlestringHuman-readable title.
bodystringnullablePreview/body text.
statusstringenumValues:unseenseenreadWhere the notification is in its lifecycle.
unseen: not yet surfaced in the notification dropdown.seen: surfaced in the dropdown but not yet opened.read: explicitly opened by the user.dismissed: removed from the active feed.
prioritystringenumValues:lownormalhighDelivery priority.
senderactorExpandablenullableThe actor that generated this notification — a user, group, agent, or API key.
System-generated notifications have no sender.
idstringUnique identifier of the actor.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor type.
user: a human user account.api_key: a programmatic caller authenticating with an API key.agent: an automated agent acting on the account's behalf.group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullableThe actor's display name.
handlestringnullableHuman-readable handle identifying the actor.
- For
useractors: the user's email address. - For
api_keyactors: the redacted key value.
Other actor types carry no handle.
avatar_urlstringnullableURL of the actor's profile photo, if one is set.
Only populated for user actors.
Assigned role.
null in this endpoint.resourceentityExpandablenullableThe app resource this notification links to, if any.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe resource kind that this entity references, as an object-type value (e.g. user, account).
Unlike object — which is always entity — this names the underlying resource the id points to.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
seen_atstring (date-time)nullableWhen the notification first appeared in the dropdown.
read_atstring (date-time)nullableWhen the notification was explicitly opened.
dismissed_atstring (date-time)nullableWhen the notification was dismissed.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
Responses
Successful response for Mark Notification Seen