/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Delete metadata

    Copy link

    You can delete a specific or all metadata of a user. Metadata stores additional user information such as their preference settings.

    Note: Do not use PII (Personally Identifiable Information) such as user email address, legal name, or phone number for data security and privacy reason.

    HTTP request

    Copy link
    // 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}


    Copy link

    The following table lists the parameters that this action supports.




    Specifies the unique ID of a user.




    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.


    Copy link

    If successful, this action returns an empty response body.

    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