Create metadata

You can create items to add to the 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.

POST https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata

The following table lists the parameters that this action supports.

The following table lists the properties of an HTTP request that this action supports.

{
    "metadata": {
        "font_preference": "times new roman",
        "font_color": "black"
    }
}

If successful, this action returns a metadata added to a user in the response body.

{
    "font_preference": "times new roman",
    "font_color": "gray" 
}

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
}