Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Remove Members

AI-generated

Summary

Remove specified members from an existing Stream Chat channel by providing the channel type, channel ID, and a comma-separated list of user IDs to remove.

Inputs

  • Channel Type — Type of the channel such as "messaging" (1-on-1 chats), "team" (group channels), or "livestream" (broadcast channels). Defaults to "messaging".
  • Channel ID (required) — Unique identifier for the channel (e.g., "general", "random", "team-alpha"). Combined with the channel type to identify the channel from which members will be removed.
  • Members (required) — Comma-separated list of user IDs to be removed from the channel. Enter user IDs without spaces around commas (e.g., "john_doe,jane_smith,admin123").

Output shape

a single JSON object representing the response from the Stream Chat API after attempting to remove the specified members from the channel.

If the operation fails, the node returns an error message describing the failure. The response includes the updated state of the channel members where applicable.

Examples

Example 1: Removing two users from a 'team' channel 'project-x'

Set Channel Type to 'team', Channel ID to 'project-x', and Members to 'user1,user2'. Upon execution, these users will be removed from the specified channel.

Discussion