Updating a Channel
Confused about "Updating a Channel"?
Let us know how we can improve our documentation:
- On This Page:
- Partial Update
- Full Update (overwrite)
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!Confused about "Partial Update"?
Let us know how we can improve our documentation:
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!Confused about "Full Update (overwrite)"?
Let us know how we can improve our documentation:
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 |