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

    Delete metadata

    Deletes a specific item or all items of the metadata of a user.


    HTTP request

    // When deleting all items of the user metadata
    DELETE https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata
    
    // When deleting a specific item by its key of the user metadata
    DELETE https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata/{key}
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    user_id

    string

    Specifies the unique ID of a user.

    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 has the specified 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.