Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Moderation

    Freeze an open channel

    Copy link

    Freezes or unfreezes an open channel.

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


    HTTP request

    Copy link
    PUT https://api-{application_id}.sendbird.com/v3/open_channels/{channel_url}/freeze
    

    Parameters

    Copy link

    The following table lists a parameter that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of the channel.


    Request body

    Copy link

    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

    Copy link

    If successful, this action returns an open channel resource in the response body.