Actions60
- User Actions
- Channel Actions
- Accept Invite
- Add Members
- Add Moderators
- Archive
- Ban User
- Create
- Delete
- Delete File
- Delete Image
- Demote Moderators
- Disable Slow Mode
- Enable Slow Mode
- Get Config
- Hide
- Invite Members
- Mark Read
- Mark Unread
- Mute
- Mute Status
- Pin
- Query Channels
- Query Members
- Reject Invite
- Remove Members
- Send Action
- Send File
- Send Image
- Show
- Stop Watching
- Truncate
- Unarchive
- Unban User
- Unmute
- Unpin
- Update
- Watch
- Message Actions
- Moderation Actions
Overview
The node performs server-side operations on Stream Chat channels, enabling management and interaction with chat channels programmatically. Specifically, the "Mark Unread" operation marks a channel as unread starting from a specified message ID. This is useful in scenarios where you want to programmatically flag a channel for a user as having unread messages from a certain point, such as when implementing custom notification logic or syncing read states across devices.
Practical examples:
- Marking a channel as unread after receiving an important message to trigger user attention.
- Resetting unread status for a channel when syncing message states from another system.
- Managing read/unread states in automated workflows that integrate with Stream Chat.
Properties
| Name | Meaning |
|---|---|
| Channel Type | The type of the channel. Common options: "messaging" (1-on-1 chats), "team" (group channels), "livestream" (broadcast channels). |
| Channel ID | Unique identifier for the channel (e.g., "general", "random", "team-alpha"). Combined with type to form the full channel ID (CID). |
| Message ID (For Mark Unread) | The message ID from which to mark the channel as unread. This indicates the starting point of unread messages in the channel. |
Output
The output JSON contains the response from the Stream Chat API for the "markUnread" operation. Typically, this will be an object confirming the unread state update on the channel. The exact structure depends on the Stream Chat API but generally includes metadata about the channel's unread status.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Stream Chat service.
- The node uses the official Stream Chat server-side client library to perform operations.
- Proper permissions must be granted to the API key to allow marking channels as unread.
Troubleshooting
Common issues:
- Invalid or missing Channel ID or Message ID parameters will cause errors.
- Insufficient permissions on the API key may result in authorization errors.
- Providing a message ID that does not exist or is not part of the channel can cause failures.
Error messages:
"Unsupported operation": Indicates the selected resource-operation combination is not implemented; ensure "Channel" resource and "Mark Unread" operation are selected.- API errors related to invalid IDs or permissions will be returned from the Stream Chat API and surfaced by the node.
Resolutions:
- Verify that the Channel Type and Channel ID are correct and correspond to an existing channel.
- Ensure the Message ID exists within the channel and is valid.
- Confirm that the API key used has the necessary permissions for channel modification operations.