Skip to main content

Identify user

PUT 

/track/user

Identifying Users

This endpoint allows you to identify or update users from your backend and associate custom properties.

Edit the Base URL in request schema for switching between regions.

Request Headers

  • apikey: Your private API key (required for authorization)

Request Body Fields

  • ext_id (string): Client-identifiable unique ID for the user
  • name (string): Name of the user (e.g., "Jon Doe")
  • email (string): Email of the user (e.g., "[email protected]")
  • phone (string): Phone number of the user (e.g., "9999999999")
  • props_int (object): Integer user attributes (e.g., rank: 1)
  • props_text (object): Text user attributes (e.g., segment: "power")
  • props_bool (object): Boolean user attributes (e.g., has_subscribed: true)
  • props_float (object): Float user attributes (e.g., wallet_balance: 50.5)

Request Validations

  • ext_id: Must match regex /^[A-Za-z0-9_]{1,99}$/
  • Property keys (in props_*): Must match /^[$A-Za-z][A-Za-z0-9_]{1,99}$/
  • props_int: Max value 2147483647
  • props_text: Max length 200 characters

Sample Request

{
"ext_id": "sample_id",
"name": "Sample User",
"phone": "9999999999",
"email": "[email protected]",
"props_int": {
"rank": 1
},
"props_text": {
"segment": "power"
},
"props_bool": {
"has_subscribed": true
},
"props_float": {
"wallet_balance": 50.5
}
}

Sample Response

{
"uid": "2762ff09-d7f0-4288-b25d-e5ffe5434724"
}

Response Fields

FieldTypeDescription
uidUnique UUIDv4 user identifier

Rate Limits

  • 100 requests per second

Request

Responses

Successful response with user UID