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

    Freeze a group channel

    Freezes or unfreezes a group channel.

    Note: To learn more about other available moderation tools, see Moderation Overview.


    HTTP request

    PUT https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/freeze
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of the channel.


    Request body

    The following table lists the property of an HTTP request that this action supports.

    Required
    Property nameTypeDescription

    freeze

    boolean

    Determines whether to freeze the channel. (Default: true)


    Response

    If successful, this action returns a group channel resource in the response body.