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

    Delete metacounter

    Deletes a channel metacounter's item from a channel.

    Note: See this page to learn more about differences among data properties.


    HTTP request

    // When deleting all items of a channel metacounter
    DELETE https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metacounter
    
    // When deleting 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. Urlencoding a key is recommended.


    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.