Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Update

AI-generated

Summary

Update a specified channel's attributes by providing its type, ID, and a JSON object with the fields to change.

Inputs

  • Channel Type — Specify the channel type such as "messaging" for 1-on-1 chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
  • Channel ID (required) — The unique identifier of the channel to update (e.g., "general", "random", "team-alpha"). Combined with type to identify the channel uniquely.
  • Channel Data (required) — A JSON object containing the channel fields to update, such as name, image, description, or custom metadata. Only include the fields you want to change.

Output shape

a single record containing the updated channel data as returned by the Stream Chat API

The output JSON reflects the updated state of the channel after applying the changes. Errors during update will throw unless 'Continue On Fail' is enabled, in which case errors will be included in the output with an error message.

Discussion