Chat Platform API v3
Chat Platform API
Chat
Platform API
Version 3
Home
/
Chat
/
Platform API
/
User
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.
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of a user. |
Optional | Type | Description |
---|---|---|
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. |
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.