Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Unban User

AI-generated

Summary

Unban a user from a specified channel by channel type and channel ID, removing any channel-specific ban restrictions on the target user.

Inputs

  • Channel Type — The type of the channel (e.g., "messaging" for 1-on-1 chats, "team" for group channels, "livestream" for broadcast channels). Defaults to "messaging".
  • Channel ID (required) — Unique identifier of the channel (e.g., "general", "random", "team-alpha"). Combined with channel type to form the channel CID.
  • Target User ID (required) — The user ID of the user to unban from the channel.

Output shape

A single JSON object representing the result of the unban action from the Stream Chat server, typically including confirmation details or updated channel state.

The output reflects the response from the Stream Chat API after successfully unbanning the user from the specified channel. Error responses will be returned if the operation fails.

Discussion