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

    Mute a user in channels by custom channel types

    Mutes a specific user in channels with particular custom channel types. If you want to mute multiple users in channels with the same custom channel type, see Mute users in channels by a custom channel type.

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


    HTTP request

    POST https://api-{application_id}.sendbird.com/v3/users/{user_id}/muted_channel_custom_types
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    user_id

    string

    Specifies the unique ID of a user. The specified user is muted for ten years, which can be considered permanent.


    Request body

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

    Properties
    RequiredTypeDescription

    channel_custom_types[]

    array of strings

    Specifies an array of one or more custom channel types.

    {
        "channel_custom_types": ["photo", "painting"]
    }
    

    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.