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

    Ban a user from channels by custom channel types

    Bans a user from channels with the specified custom channel types.

    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}/banned_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.


    Request body

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

    Required
    Property nameTypeDescription

    channel_custom_types[]

    array of strings

    Specifies an array of one or more custom channel types to ban a user from.

    {
        "channel_custom_types": ["cartoon", "movie"]
    }
    

    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.