Users API
The Users API allows you to create, update, and manage user identities and profiles.
Set User Properties
Creates a new user profile or updates an existing one if the distinct_id already exists.
Endpoint
POST /public/users/identify
Authentication
Include your Secret Key in the JSON payload.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | string | Yes | Your Secret Key. |
| distinct_id | string | Yes | The unique identifier of the user. |
| properties | object | No | A dictionary of properties to set on the user's profile. |
Request Example
cURLbash
1curl -X POST "https://gateway.solvof.com/public/users/identify" \2 -H "Content-Type: application/json" \3 -d '{4 "apiKey": "YOUR_API_KEY",5 "distinct_id": "user_123",6 "properties": {7 "$name": "John Doe",8 "$email": "test@test.com",9 "plan": "pro"10 }11 }'API Playground
POST
apiKey*string
distinct_id*string
propertiesobject
Advanced Profile Operations (People API)
Increment numeric values (e.g., login count) or append to arrays (e.g., list of interests) safely without overwriting the entire profile.
Endpoint
POST /public/users/profile
Authentication
Privileged Endpoint
This endpoint requires your API Key.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | string | Yes | Your Secret Key. |
| distinct_id | string | Yes | The unique identifier of the user. |
| operations | object | Yes | An object detailing the operations to perform ($set, $add, $append). |
Request Example
json
1{2 "apiKey": "YOUR_API_KEY",3 "distinct_id": "user_123",4 "operations": {5 "$set": {6 "last_login": "2023-10-27"7 },8 "$add": {9 "login_count": 110 }11 }12}API Playground
POST
apiKey*string
distinct_id*string
operations*object
Delete User
Permanently delete a user and their profile data. Note: this may not delete all associated events depending on your configuration.
Endpoint
DELETE /public/users/:userId
Authentication
Privileged Endpoint
This endpoint requires your Secret Key.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string (path) | Yes | The distinct_id of the user to delete. |
Request Example
bash
1curl -X DELETE "https://gateway.solvof.com/public/users/user_123" \2 -H "x-api-key: YOUR_API_KEY"