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

    Delete metacounter

    This action deletes one or more items of a channel metacounter. Metacounter is additional information about a channel that is a collection of of key-value pairs where the value is always an integer.

    Note: See the channel overview page to learn more about differences among data properties.


    HTTP request

    // Delete all items of a channel metacounter
    DELETE https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metacounter
    
    // Delete a specific item of a channel metacounter by its key
    DELETE https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metacounter/{key}
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_type

    string

    Specifies the type of a channel. Acceptable values are open_channels and group_channels.

    channel_url

    string

    Specifies the URL of a channel where the metacounter is.

    OptionalTypeDescription

    key

    string

    Specifies the key of the metacounter item. If not specified, all items of the metacounter are deleted. If specified, only the item that matches the parameter value is deleted. URL encoding a key is recommended.


    Response

    If successful, this action returns an empty response body.

    Error

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "\"Channel\" not found.",
        "code": 400105,
        "error": true
    }