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

    Unban users from channels by a custom channel type

    Unbans users who had been banned from channels with the specified custom channel type at once.


    HTTP Request

    DELETE https://api-{application_id}.sendbird.com/v3/applications/settings_by_channel_custom_type/{custom_type}/ban
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    custom_type

    string

    Specifies a custom channel type.

    user_ids[]

    array of strings

    Specifies an array of one or more unique IDs of banned users to unban from channels with the specified custom type. Urlencoding each user ID is recommended (for example, ?user_ids=urlencoded_id_1,urlencoded_id_2).

    ?user_ids=Joe,Harry
    

    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.