Section ID:
Values of
DOC-API-MODEL-schema-1kescd68ar#overview
InboxMessage
Notification content and interaction state displayed in a subscriber’s inbox.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1kescd68ar#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1kescd68ar#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1kescd68ar#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-messageidSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-messageidmessageId | string | Optional | Identifier of the message represented by this inbox entry. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-notificationidSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-notificationidnotificationId | string | Optional | Identifier of the notification represented by this inbox entry. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-titleSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-titletitle | string | Optional | Title displayed for the inbox notification. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-bodySection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-bodybody | string | Optional | Body text of the inbox message. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-dataSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-datadata | Map from string to string | Optional | Additional key-value attributes attached to the inbox notification. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-deeplinkSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-deeplinkdeepLink | string | Optional | Application deep link associated with the inbox message. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-imageurlSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-imageurlimageUrl | string | Optional | Image URL associated with the inbox message. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-statusSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-statusstatus | string (MESSAGE_STATUS_UNSEEN, MESSAGE_STATUS_SEEN, MESSAGE_STATUS_READ, MESSAGE_STATUS_UNREAD, MESSAGE_STATUS_ARCHIVED) or integer (int32) | Optional; explicit presence | Read, seen, or archived state recorded for the inbox message. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-categorySection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-categorycategory | string | Optional | Category assigned to the inbox message or workflow. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-createdatSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-seenatSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-seenatseenAt | string (date-time) | Optional | Time when the inbox message was marked seen. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-readatSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-readatreadAt | string (date-time) | Optional | Time when the inbox message was marked read. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-actionsSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-actionsactions | Array of InboxMessageAction | Optional | See meaning below. |
tags | Array of string | Optional | Workflow tags for tab assignment (OR-filtered in feed). |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-archivedSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-archivedarchived | boolean | Optional | Whether this inbox notification is archived. |
Section ID: DOC-API-MODEL-schema-1kescd68ar#field-archivedatSection ID: DOC-API-MODEL-schema-1kescd68ar#response-field-archivedatarchivedAt | string (date-time) | Optional | Time when the inbox message was archived. |
actions
Interactive actions attached to the inbox message.
CTA buttons
Values of status
Section ID: DOC-API-MODEL-schema-1kescd68ar#response-values-status
Inbox state or requested state transition for a notification message.
| Value | No. | Form | Meaning |
|---|---|---|---|
MESSAGE_STATUS_UNSEEN | 0 | Canonical | The message has not been marked seen or read. |
MESSAGE_STATUS_SEEN | 1 | Canonical | The message has been marked seen and is not marked read or archived. |
MESSAGE_STATUS_READ | 2 | Canonical | The message has been marked read and is not archived. |
MESSAGE_STATUS_UNREAD | 3 | Canonical | Request clearing the read state; this is an update action rather than a distinct status emitted by message reads. |
MESSAGE_STATUS_ARCHIVED | 4 | Canonical | The message has been archived; this state takes precedence over seen and read when reported. |
Where used
Section ID: DOC-API-MODEL-schema-1kescd68ar#where-used
| Reference | Relationship |
|---|---|
| Get inbox feed messages | POST /api/v1/notifications/get-inbox-feed |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1kescd68ar