Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Channel

    Unhide a channel

    This action lets a hidden group channel reappear on the channel list of a specific user or every member in the group channel. Hiding or unhiding a channel lets users organize their channel list based on those that require the most attention. Note that only group channels can be hidden or unhidden.


    HTTP request

    DELETE https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/hide
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_url

    string

    Specifies the URL of the channel.

    user_id

    string

    Specifies the unique ID of the user whose hidden channel will reappear on the user's channel list. This property is required when the value of the should_unhide_all property is set to its default value false. However, when the value of the should_unhide_all property is set to true, the value of the user_id property is ignored even when specified. It is recommended that you URL-encode the value like the following: ?user_id=url-encoded%20id.

    OptionalTypeDescription

    should_unhide_all

    boolean

    Determines whether to make the specified channel reappear on every channel member's channel list. If set to true, the value of the user_id property is ignored even when specified. If set to false, the channel only reappears on the channel list of the member specified in user_id. (Default: false)

    ?user_id=Jeff
    

    Responses

    If successful, this action returns an empty response body.

    Error

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "\"Channel\" not found.",
        "code": 400201,
        "error": true
    }