InboxMessage
Notification content and interaction state displayed in a subscriber’s inbox.
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 message represented by this inbox entry. |
notificationId | string | Optional | Identifier of the notification represented by this inbox entry. |
title | string | Optional | Title displayed for the inbox notification. |
body | string | Optional | Body text of the inbox message. |
data | Map from string to string | Optional | Additional key-value attributes attached to the inbox notification. |
deepLink | string | Optional | Application deep link associated with the inbox message. |
imageUrl | string | Optional | Image URL associated with the inbox message. |
status | string (MESSAGE_STATUS_UNSEEN, MESSAGE_STATUS_SEEN, MESSAGE_STATUS_READ, MESSAGE_STATUS_UNREAD, MESSAGE_STATUS_ARCHIVED) or integer (int32) | Optional | Read, seen, or archived state recorded for the inbox message. |
category | string | Optional | Category assigned to the inbox message or workflow. |
createdAt | string (date-time) | Optional | Time when this record was created. |
seenAt | string (date-time) | Optional | Time when the inbox message was marked seen. |
readAt | string (date-time) | Optional | Time when the inbox message was marked read. |
actions | Array of InboxMessageAction | Optional | Interactive actions attached to the inbox message. |
tags | Array of string | Optional | Workflow tags for tab assignment (OR-filtered in feed). |
archived | boolean | Optional | Whether this inbox notification is archived. |
archivedAt | string (date-time) | Optional | Time when the inbox message was archived. |
Values of status
Inbox state or requested state transition for a notification message.
| Value | No. | Form | Meaning |
|---|---|---|---|
MESSAGE_STATUS_UNSEEN | 1 | Canonical | The message has not been marked seen or read. |
MESSAGE_STATUS_SEEN | 2 | Canonical | The message has been marked seen and is not marked read or archived. |
MESSAGE_STATUS_READ | 3 | Canonical | The message has been marked read and is not archived. |
MESSAGE_STATUS_UNREAD | 4 | Canonical | Request clearing the read state; this is an update action rather than a distinct status emitted by message reads. |
MESSAGE_STATUS_ARCHIVED | 5 | Canonical | The message has been archived; this state takes precedence over seen and read when reported. |
Where used
| Reference | Relationship |
|---|---|
| Get inbox feed messages | POST /api/v1/notifications/get-inbox-feed |
Download the public reference contract.
Document: DOC-API-MODEL-inbox-message.