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

    Unhide a channel

    Displays a hidden channel on the channel list of a specific user or every member of a group channel.

    Note: See this page to learn more about channel types.


    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 a value of the should_unhide_all property is set to its default value false. However, when a value of the should_unhide_all property is set to true, a value of the user_id property is ignored even when specified. Urlencoding the value is recommended (for example, ?user_id=urlencoded_id).

    OptionalTypeDescription

    should_unhide_all

    boolean

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

    ?user_id=Jeff
    

    Response

    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.