Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Hide

AI-generated

Summary

Hide a specific channel for a user in the Stream Chat service, optionally clearing the channel's message history as part of the hiding process.

Inputs

  • Channel Type — Specify the type of the channel such as "messaging", "team", or "livestream". Default is "messaging".
  • Channel ID (required) — Provide the unique identifier of the channel to hide (e.g., "general", "random", "team-alpha").
  • User ID — Specify the user ID on whose behalf the channel is being hidden. If omitted, the operation may run without a specific user context.
  • Clear History — A boolean to indicate whether to clear the channel's message history when hiding it. Defaults to false.

Output shape

a single JSON object containing the API response from the hide channel call

The output will include the server response to the hide operation. If the operation fails, error information will be returned in the usual n8n error format.

Discussion