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

    Delete metadata

    Deletes one or more items of a channel's metadata that are stored in a channel.

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


    HTTP request

    // When deleting all items of a channel metadata
    DELETE https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metadata
    
    // When deleting a specific item of a channel metadata by 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. 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.