/messages/unread

Unique ID of the message

Generic event name key. Can be used to classify the message origin based on the triggering event.

Placement value allows ordering messages based on their importance. Values are descending in importance.

Message will persist as unread and cannot be dismissed. Marking a message as read with this property will fail.

Indicates the client app should automatically mark the message as read when interacted with. Client apps should update this property manually.

Indicates the message has been read or dismissed by the user. Client apps should update this property manually.

Indicates the message has been interacted with by either tapping a link or dismissing. Client apps should update this property manually.

Message types of the message. Indicates the locations in the app the message should be rendered or how the message should be consumed.

Indicates the content type of the message and how it should be rendered

• html - The content is an HTML payload and should be rendered in a web view
• image - The content contains an image. Image should be fetched and rendered from the URL
• text - The content contains text only and possibly an icon. Use design_type to determine how to render the content
• video - The content contains a video. Video should be streamed from the URL provided