Hide or archive a channel

PUT {{baseUrl}}/v3/group_channels/:channel_url/hide

Hide or archive a channel

Hides or archives a channel from the channel list of either a specific user or entire channel members. Normally, a hidden channel comes back and shows up in the channel list when a member in the channel sends a new message. This automatically-triggered behavior is intended for users who want to temporarily remove a channel from their list because leaving the channel would delete all the past messages and stored data.

You can also leave out a channel from the list and archive the channel. The channel doesn't appear even when receiving a new message from other member.

https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-hide-or-archive-a-channel

Request Body

{"channel_url"=>"<string>", "user_id"=>"<string>", "allow_auto_unhide"=>"<boolean>", "should_hide_all"=>"<boolean>", "hide_previous_messages"=>"<boolean>"}

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;anyOf&quot;:&quot;\u003cstring\u003e&quot;}