Overview
Deletes custom attributes from a specified chatroom.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/chatrooms/atts/del
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| from_id | string | Yes | ID of the user deleting the attributes. Maximum length: 32 characters. | |
| chat_id | string | Yes | Chatroom ID. Maximum length: 32 characters. | |
| atts | array | Yes | Attributes to delete. Each key can contain up to 50 characters. | |
| atts[0].key | string | Yes | Attribute key. Maximum length: 50 characters. | |
| atts[0].is_force | bool | No | Whether to force deletion. Default: false. |
Request Example
POST /apigateway/chatrooms/atts/del HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"from_id":"userid1",
"chat_id":"chatroom1",
"atts":[
{
"key":"k1",
"is_force":false
}
]
}
Response Example
{
"code":0,
"msg":"sucess",
"data":{
"atts":[
{
"key":"k1",
"code":0,
"att_time":1732123445223
}
]
}
}