Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Unarchive

AI-generated

Summary

Unarchive a specified channel to restore its active status in Stream Chat.

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 to unarchive (e.g., "general", "random", "team-alpha"). This is combined with the type to form the channel CID.
  • User ID — User ID to associate with the unarchive operation for server-side context, if applicable.

Output shape

a single record

Returns the API response from the Stream Chat server for the unarchive operation on the specified channel. The result typically includes the updated channel data showing it is no longer archived.

Examples

Example 1: Unarchive a messaging channel named 'general' by specifying its type and ID

Set Channel Type to 'messaging', Channel ID to 'general', and optionally provide User ID if needed for server context.

Discussion