사용자 속성

사용자 속성 API를 사용하면 이벤트를 전송하지 않고 사용자의 속성을 업데이트 할 수 있습니다.
업데이트된 속성은 소급적용되지 않으며, 업데이트 이후에 발생된 이벤트에만 적용됩니다.

Authentication

SDK 키를 통해 인증을 진행합니다. SDK 키를 HTTP 헤더로 전송해야 합니다.
API를 호출하는 곳에따라 Browser, App, Server SDK 키중 하나를 헤더로 설정합니다.

X-HACKLE-API-KEY: {YOUR_SDK_KEY}

Request

POST https://api.hackle.io/v1/properties

Request Body

Field	Type	Required	Description
userId	string	X	사용자 ID (deviceId 가 없는 경우 필수입니다)
deviceId	string	X	디바이스 ID (userId 가 없는 경우 필수입니다)
operations	Operations Object	O	사용자 속성 업데이트를 위한 정보를 나타내는 object 입니다.

Operations Object

Field	Type	Required	Description
$set	object	X	속성의 값을 설정합니다. 설정하고자 하는 속성의 키-값의 object 입니다.
$setOnce	object	X	값이 아직 설정되지 않은 경우에만 값을 설정합니다. 설정하고자 하는 속성의 키-값의 object 입니다.
$unset	object	X	속성을 제거합니다. 제거하고자 하는 속성의 키-값의 object 입니다.

Example

curl -i -X POST \
  'https://api.hackle.io/v1/properties' \
  -H 'X-HACKLE-API-KEY: YOUR_SDK_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "19285035",
    "deviceId": "ae2182e0",
    "operations": {
      "$set": {
        "age": 42,
        "grade": "GOLD"
      },
      "$setOnce": {
        "sign_up_date": "2020-01-01"
      },
      "$unset": {
        "membership_type": "-"
      }
    }
  }'

Response

200 OK

성공적인 요청인 경우 200 응답 상태를 반환합니다.

400 Bad Request

유효하지 않은 요청 정보인 경우 400 상태를 반환합니다.

401 Unauthorized

X-HACKLE-API-KEY 헤더값이 없거나 유효하지 않은 SDK 키인 경우 401 상태를 반환합니다

Updated 10 months ago