Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Mark Read

AI-generated

Summary

Mark the specified chat channel as read, updating the read state for the current user on the server side.

Inputs

  • Channel Type — The type of channel to mark as read (e.g., "messaging", "team", "livestream"). Defaults to "messaging".
  • Channel ID (required) — The unique identifier of the channel to mark as read (e.g., "general", "random"). Combined with Channel Type to identify the channel.

Output shape

a single record containing the updated channel read state object returned by the Stream Chat API.

The returned JSON reflects the server's updated read state for the channel. No pagination applies. An API error will occur if the channel does not exist or if permissions are insufficient.

Examples

Example 1: Mark the channel 'general' of type 'messaging' as read

Set Channel Type to 'messaging', Channel ID to 'general', and execute this operation to update the read status for your user.

Discussion