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

    Delete metadata

    You can delete a specific or all metadata of a user. Metadata stores additional user information such as phone number, email or a description of the 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.


    Responses

    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": "\"User\" not found.",
        "code": 400201,
        "error": true
    }