InboxMessageSummary
Summary of an inbox message after a mark operation.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
messageId | string | Optional | Identifier of the inbox message represented by this summary. |
channel | string | Optional | Delivery channel reported for this inbox message. |
read | boolean | Optional | Whether the inbox message has been marked read. |
seen | boolean | Optional | Whether the inbox message has been marked seen. |
archived | boolean | Optional | Whether this inbox message is archived. |
content | string | Optional | Rendered notification content. |
subject | string | Optional | Subject text for the notification message. |
status | string | Optional | Status reported by the notification provider. |
createdAt | string | Optional | Time when this record was created. |
lastReadDate | string | Optional | Most recent timestamp recorded for reading inbox messages. |
lastSeenDate | string | Optional | Most recent timestamp recorded for seeing inbox messages. |
Where used
| Reference | Relationship |
|---|---|
| Mark a single inbox message | POST /api/v1/notifications/mark-inbox-message |
Download the public reference contract.
Document: DOC-API-MODEL-inbox-message-summary.