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

    Delete metadata

    This action deletes key-value items used to store additional information about a channel. You can delete a specific item using its key or delete all items.

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


    HTTP request

    // Deletes all items stored to a channel.
    DELETE https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metadata
    
    // Deletes a specific item stored to a channel using its key.
    DELETE https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metadata/{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 metadata is.

    OptionalTypeDescription

    key

    string

    Specifies the key of a metadata item. If not specified, all items of the metadata 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": 400201,
        "error": true
    }