InAppNotificationItemDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One notification in the signed-in user's inbox.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
eventType
required |
string | The event type that produced the notification, for example `Transaction.Declined`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
category
required |
string | The event type's catalog category, for example `Transactions`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
title
required |
string | The notification title.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
body
required |
string | A short plain-text summary, or `null`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
actionUrl
required |
string | A relative in-app path to the record the notification is about, or `null`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
priority
required |
InAppNotificationItemPriority InAppNotificationItemPriority | How prominently the notification is shown.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isRead
required |
boolean | Whether the user has read the notification.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
readAt
required |
string (date-time) | When the user read the notification (UTC), or `null`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
createdAtUtc
required |
string (date-time) | When the notification was written (UTC).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.