Hides a channel from the channel list. This API allows you to hide a channel for a specific member or archive a channel for all channel members. Also, you can determine whether to have the channel remain hidden or archived when a new message is sent to the channel.
Note: See this page to learn more about channel types.
The following table lists the parameters that this action supports.
Specifies the URL of a channel.
The following table lists the properties of an HTTP request that this action supports.
Specifies the unique ID of the user whose channel will be hidden or archived from the list. This property is required when
Determines whether to have the channel remain hidden when a new message is sent to the channel. If set to true, the hidden channel will reappear on the channel list when there is a new message in the channel. If set to false, the channel still remains hidden. (Default: true)
Determines whether to archive a specified channel from every channel member's channel list. If set to true, a value of the
When the channel reappears on a single user's or every channel member's channel list, determines whether to hide messages that were sent to the channel before the channel was hidden. (Default: false)
If successful, this action returns an empty response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.