Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Archive

AI-generated

Summary

Archive a channel in Stream Chat by specifying its type and unique identifier, optionally on behalf of a user.

Inputs

  • Channel Type — Type of the channel to archive, e.g., "messaging" for 1-on-1 chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
  • Channel ID (required) — Unique identifier for the channel to archive (e.g., "general", "random", "team-alpha"). Combined with the channel type to form the full channel identifier (CID).
  • User ID — Optional user ID for the server-side operation to archive the channel as that user.

Output shape

a single JSON object representing the result of the channel archive operation

The output contains the response from the Stream Chat server after attempting to archive the specified channel. Any errors will be included in the node's error output if applicable.

Discussion