Set User Attributes

最新の更新:2025-03-18

Invocation Address

POST /v1/user/property

Invocation Verification

The EngageLab REST API uses the verification method of HTTP Basic Authentication: Add Authorization to the HTTP Header:

Authorization: Basic ${base64_auth_string}
          Authorization: Basic ${base64_auth_string}

        
このコードブロックは、フローティングウィンドウに表示されます

The generation algorithm for the above base64_auth_string is: base64(api_key:api_secret)

  • The header name is "Authorization", and the value is the base64-converted "username:password" pair (with a colon in the middle).
  • In the scenario of the MA API, the username is the APIKey, and the password is the APISecret. Please add a data source of the API type in the data source to obtain the APIKey and API Secret.

Request Example

Request Header

> POST /v1/user/property > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
          > POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

        
このコードブロックは、フローティングウィンドウに表示されます

Request Body

{ "euid": 10362473, "type": "set", "properties": { "user_number_once": 46.2, // User property name and property value "user_string_once": "refef", "user_datetime_once": "2023-12-12 00:56:23" } }
          {
    "euid": 10362473,
    "type": "set",
    "properties": {
        "user_number_once": 46.2, // User property name and property value
        "user_string_once": "refef",
        "user_datetime_once": "2023-12-12 00:56:23"
    }
}

        
このコードブロックは、フローティングウィンドウに表示されます

Request Parameters

Field Type Required Description
euid Long Yes The unique user ID of EngageLab MA
type String Yes The operation type for updating the properties
properties JSON Yes The list of user properties, where the key is the property name and the value is the property value

Return Parameters

Field Type Required Description
code Int Yes Indicates whether the interface call is successful. 0 means successful or partially successful, and other values represent failure
message String Yes The description of the interface call result, an explanation of the return code

All Successful

{ "code": 0, "message": "success" }
          {
    "code": 0,
    "message": "success"
}

        
このコードブロックは、フローティングウィンドウに表示されます

All Failed

{ "code": 55102, "message": "Invalid user attributes exist" }
          {
    "code": 55102,
    "message": "Invalid user attributes exist"
}

        
このコードブロックは、フローティングウィンドウに表示されます

Error Codes

Error Code Error Code Explanation Solution
40050 Interface authentication failed Confirm whether the secret key is correct
55004 Business parameters are invalid Please check if the properties field is correct
55102 There are invalid user attributes Confirm whether the property key is valid
55103 User property values cannot be empty Confirm whether the values of user properties in the request body are empty
在文档中心打开
icon
営業に連絡する