Section ID:
DOC-API-MODEL-schema-ojt6e86adl#overview
InboxMessageSummary
Summary of an inbox message after a mark operation.
Meaning and usage
Section ID: DOC-API-MODEL-schema-ojt6e86adl#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ojt6e86adl#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-ojt6e86adl#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-messageidSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-messageidmessageId | string | Optional | Identifier of the inbox message represented by this summary. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-channelSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-channelchannel | string | Optional | Delivery channel reported for this inbox message. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-readSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-readread | boolean | Optional | Whether the inbox message has been marked read. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-seenSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-seenseen | boolean | Optional | Whether the inbox message has been marked seen. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-archivedSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-archivedarchived | boolean | Optional | Whether this inbox message is archived. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-contentSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-contentcontent | string | Optional | Rendered notification content. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-subjectSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-subjectsubject | string | Optional | Subject text for the notification message. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-statusSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-statusstatus | string | Optional | Status reported by the notification provider. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-createdatSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-createdatcreatedAt | string | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-lastreaddateSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-lastreaddatelastReadDate | string | Optional | Most recent timestamp recorded for reading inbox messages. |
Section ID: DOC-API-MODEL-schema-ojt6e86adl#field-lastseendateSection ID: DOC-API-MODEL-schema-ojt6e86adl#response-field-lastseendatelastSeenDate | string | Optional | Most recent timestamp recorded for seeing inbox messages. |
Where used
Section ID: DOC-API-MODEL-schema-ojt6e86adl#where-used
| Reference | Relationship |
|---|---|
| Mark a single inbox message | POST /api/v1/notifications/mark-inbox-message |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ojt6e86adl