tencent cloud

Deleting User Attributes
Download PDF
Last updated: 2025-10-23 15:30:54
Deleting User Attributes
Last updated: 2025-10-23 15:30:54
Download PDF

Feature Overview

The administrator removes attributes from users. Note that you can only remove attributes for up to 100 users at a time. Before using it, please set the application attribute names .

Sample request URL

https://xxxxxx/v4/timpush/remove_attr?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json

Request parameters

Parameter
Description
https
Request protocol: HTTPS
Request method: POST
xxxxxx
The dedicated domain corresponding to the country/region of your SDKAppID.
China: console.tim.qq.com
Singapore :adminapisgp.im.qcloud.com
Seoul : adminapikr.im.qcloud.com
Tokyo：adminapijpn.im.qcloud.com
Frankfurt :adminapiger.im.qcloud.com
Silicon Valley :adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/remove_attr
Request API.
usersig
The Signature generated by the App admin account. For details, see Generating UserSig.
identifier
You must be an App admin account. For more details, see App Admins.
sdkappid
SdkAppid assigned by the Instant Messaging Console when an application is created.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Fixed value: json

Call frequency limit

100 times per second.

Sample request packets

{
    "UserAttrs": [
        {
            "To_Account": "Mary",
            "Attrs": [
                "sex",
                "city"
            ]
        },
        {
            "To_Account": "xiaoming",
            "Attrs": [
                "sex",
                "city"
            ]
        }
    ]
}

Request packet fields

Field
Type
Attribute
Description
UserAttrs
Array
Required
The array of user attributes. A single user attribute consists of To_Account and Attrs.
To_Account
String
Required
Target User Account.
Attrs
Array
Required
Set of attribute names, note that only attribute names are needed here, not key-value pairs.

Sample response packets

All successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
Partially successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ErrorList": [
        {
            "ErrorCode": 70107,
            "To_Account": "Mary"
        }
    ]
}

Response packet field description

Field
Type
Description
ActionStatus
String
Request processing result:
OK: processing successful.
FAIL: processing failed.
ErrorCode
Integer
Error Codes.
ErrorInfo
String
Error message.
ErrorList
Object Array
Set attributes may be partially successful for some users and partially failed for others. Error message list for failed accounts.
Field description of json Object in the ErrorList array
Field
Type
Description
To_Account
String
Target user account.
ErrorCode
Integer
Error code.
ErrorInfo
String
Error description, which may be empty.

Error codes

Unless a network error occurs (e.g., a 502 error), the HTTP status code for this interface will always be 200.The real error codes and messages are indicated in the response body by ErrorCode and ErrorInfo. For common error codes (60000 to 79999), see the Error Code document.
Private error codes for this API are as follows:
Error code
Description
90001
Failed to parse JSON format, please check if the request packet conforms to JSON specification.
90009
The request requires App administrator permissions.
90018
The number of requested accounts exceeds the limit.
90033
Invalid Attribute.
91000
Internal server error, please retry.

API Debugging Tool

Use the RESTful API Online Test tool to debug this interface.

Reference

All-user/Tag Push
Set application attribute name
Get application attribute name
Set user attributes
Delete user attributes
Get User Attributes
Add User Tags
Get User Tags
Delete User Tags
Clear User Tags
Push Recall
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback