tencent cloud


Setting User Attributes

Last updated: 2023-03-21 10:38:37

    Feature Overview

    This API is used by the admin to set attributes for users. Each request can set attributes for a maximum of 100 users. Before using this API, be sure to set app attribute names.

    API Calling Description

    Pushing to all users is available only to the Ultimate edition. To use it, you need to purchase the Ultimate edition, go to the console, choose Feature Configuration > Login and Message > Push to all users, and enable the feature.

    Sample request URL


    Request parameters

    Parameter Description
    https The request protocol is HTTPS and the request method is POST.
    xxxxxx Domain name corresponding to the country/region where your SDKAppID is located.
  • China: console.tim.qq.com
  • Singapore: adminapisgp.im.qcloud.com
  • Seoul: adminapikr.im.qcloud.com
  • Frankfurt: adminapiger.im.qcloud.com
  • Mumbai: adminapiind.im.qcloud.com
  • Silicon Valley: adminapiusa.im.qcloud.com
  • v4/all_member_push/im_set_attr Request API
    usersig Signature generated in the app admin account. For more information, see Generating UserSig.
    identifier The app administration account.
    sdkappid SDKAppID assigned by the Chat console when an app is created
    random A random 32-bit unsigned integer
    contenttype The value is always json.

    Maximum call frequency

    100 times/second

    Sample request

                "To_Account": "xiaojun012",
                "Attrs": {
                    "sex": "attr1",
                    "city": "attr2"
                "To_Account": "xiaojun013",
                "Attrs": {
                    "city": "attr3",
                    "sex": "attr4"

    Request fields

    Field Type Required Description
    To_Account String Yes Target user account
    Attrs Object Yes Attribute set. Each attribute is a key-value pair, with the key being the attribute name and the value being the user’s corresponding attribute value. A user attribute value cannot exceed 50 bytes.

    Sample response

        "ActionStatus": "OK",
        "ErrorInfo": "",
        "ErrorCode": 0

    Response fields

    Field Type Description
    ActionStatus String Request result. OK: Successful. FAIL: Failed
    ErrorCode Integer Error code
    ErrorInfo String Error information

    Error Codes

    Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response represent the actual error code and error information. For public error codes (60000 to 79999), please see Error Codes.
    The following table describes the error codes specific to this API:

    Error Code Description
    90001 Failed to parse the JSON format. Check whether the JSON request meets JSON specifications.
    90009 The request requires app admin permissions.
    90018 The number of requested accounts exceeds the limit.
    90033 Invalid attribute.
    91000 Internal service error. Try again.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.


    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support