Set User Attributes

Invocation Address

POST /v1/user/property

Invocation Verification

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

              
              Authorization: Basic ${base64_auth_string}

            

The base64_auth_string is generated using the following algorithm: base64(api_key:api_secret).

• The header name is "Authorization", and the value is the base64-encoded "username:password" pair (separated by a colon).
• For the MA API, the username corresponds to the APIKey, and the password corresponds to the APISecret. Please configure an API-type data source to obtain the APIKey and API Secret.

Request Example

Request Header

              
              > 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"
    }
}

            

Request Parameters

Operation Types

All properties in one request use the same type. Supported values are set, increase, add, remove, delete, setOnce, and update:

Object Array Operations

For an object_array property, the value for add is one JSON object and the value for set is an array of JSON objects. remove and update locate an item with $identifier_key and $identifier_value. The identifier field must be a defined string or number subfield of that property.

The value for remove may contain only these identifier fields:

              
              {
  "euid": 10362473,
  "type": "remove",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001"
    }
  }
}

            

update must also include a non-empty $new_object. $new_object cannot contain the identifier field; fields with a null value are removed from the matched item. The identifier must match exactly one array item.

              
              {
  "euid": 10362473,
  "type": "update",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001",
      "$new_object": {
        "model": "iPhone 16",
        "legacy_field": null
      }
    }
  }
}

            

Return Parameters

All Successful

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

            

All Failed

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

            

Error Code