Profiles API

Update a users profile

post

Authorizations

WriteOnlyBearerAuth

AuthorizationstringRequired

Your Integration API Write Only API Key. Note: You must use the Write Only API Key, not the Read + Write API Key when using this key in a public website or app for frontend analytics tracking.

Query parameters

locationEnrichmentbooleanOptional

Body

application/json

userIdstringOptionalExample: {userId} or null

anonymousIdstringOptionalExample: {anonymousId} or null

propertiesobjectOptional

Responses

204

Successful Response

No content

post/profile

HTTPcURLJavaScriptPython

POST /profile HTTP/1.1
Host: integration-api.userflux.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "userId": "{userId} or null",
  "anonymousId": "{anonymousId} or null",
  "properties": {
    "property1": "value",
    "property2": 123,
    "property3": true,
    "property4": null,
    "property5": {
      "nestedProperty1": "value"
    }
  }
}

204

Successful Response

No content

Get a users profile

get

Authorizations

ReadWriteOnlyBearerAuth

AuthorizationstringRequired

Your Integration API Read + Write API Key. Note: You must use the Read + Write API Key, not the Write Only API Key.

Path parameters

userIdstringRequired

ID of the user to fetch

Responses

200

Successful response

application/json

idstringOptional

The users id

anonymousIdsarrayOptional

Any linked anonymous ids to the user

propertiesobjectOptional

All the properties you have inserted for the user

computedPropertiesobjectOptional

All the extended properties of the user generated by the platform

segmentsarrayOptional

All the keys of segments the user belongs to

locationDataobjectOptional

All location information associated with the user

deviceDataobjectOptional

All device information associated with the user

lastUpdatedAtnumberOptional

A timestamp (in epoch milliseconds) of when the users profile was last updated

createdAtnumberOptional

A timestamp (in epoch milliseconds) of when the users profile was first inserted

get/profile/{userId}

HTTPcURLJavaScriptPython

GET /profile/{userId} HTTP/1.1
Host: integration-api.userflux.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

{
  "id": "text",
  "anonymousIds": [],
  "properties": {},
  "computedProperties": {},
  "segments": [],
  "locationData": {},
  "deviceData": {},
  "lastUpdatedAt": 1,
  "createdAt": 1
}