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

    Mute a participant in an open channel

    Mutes a participant in an open channel. A muted participant remains in the channel and is allowed to view the messages, but can't send messages until unmuted.

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


    HTTP request

    POST https://api-{application_id}.sendbird.com/v3/open_channels/{channel_url}/mute
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of a channel.


    Request body

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

    Properties
    RequiredTypeDescription

    user_id

    string

    Specifies the ID of a user.

    OptionalTypeDescription

    seconds

    long

    Specifies the duration of mute in seconds. If set to -1, the user will be muted for ten years, which refers to a permanent mute in the Sendbird Dashboard. (Default: -1)

    description

    string

    Specifies the reason for mute. The maximum length is 2,048 characters.


    Response

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

    In the case of an error, an error object is returned. A detailed list of error codes is available here.