Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Mark Unread

AI-generated

Summary

Mark a specific channel as unread from a given message ID for server-side operations, specifying the channel type, channel ID, and the message ID to mark unread from.

Inputs

  • Channel Type — The type of the channel, such as "messaging" for 1-on-1 chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
  • Channel ID (required) — The unique identifier of the channel (e.g., "general", "random", "team-alpha"), combined with the type to form the channel CID.
  • User ID — Optional user ID for server-side operations.
  • Message ID (For Mark Unread) (required) — The ID of the message from which to mark the channel as unread.

Output shape

a single JSON object representing the outcome of the mark unread operation from the Stream Chat server client.

The response includes the server's result of the mark unread request. Errors will throw exceptions unless 'Continue On Fail' is enabled, in which case error details are returned per input item.

Examples

Example 1: Mark the 'general' messaging channel as unread from message ID 'msg123'

Set Channel Type to 'messaging', Channel ID to 'general', and Message ID (For Mark Unread) to 'msg123'.

Discussion