Updating a Channel

LAST EDIT May 26 2021

There are two ways to update a channel using the Stream API - a partial or full update. A partial update will retain any custom key-value data, whereas a complete update is going to remove any that are unspecified in the API request.

Partial Update

Copied!

A partial update can be used to set and unset specific fields when it is necessary to retain additional custom data fields on the object. AKA a patch style update.

Full Update (overwrite)

Copied!

The update function updates all of the channel data. Any data that is present on the channel and not included in a full update will be deleted.

Request Params

Copied!

Name

Type

Description

Optional

channel data

object

Object with the new channel information. One special field is "frozen". Setting this field to true will freeze the channel. Read more about freezing channels in "Freezing Channels"

text

object

Message object allowing you to show a system message in the Channel that something changed.

Yes

Updating a channel using these methods cannot be used to add or remove members. For this, you must use specific methods for adding/removing members, more information can be found here.