Profiles API

Update a users profile

POSThttps://integration-api.userflux.co/profile

Authorization

BearerAuth

Query parameters

Body

application/json

userIdstring

Example: "{userId} or null"

anonymousIdstring

Example: "{anonymousId} or null"

propertiesobject

Response

204

Successful Response

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration-api.userflux.co/profile', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "{userId} or null",
      "anonymousId": "{anonymousId} or null",
      "properties": {
        "property1": "value",
        "property2": 123,
        "property3": true,
        "property4": null,
        "property5": {
          "nestedProperty1": "value"
        }
      }
    }),
});
const data = await response.json();

Get a users profile

GEThttps://integration-api.userflux.co/profile/{userId}

Authorization

BearerAuth

Path parameters

userId*string

ID of the user to fetch

Response

200

Successful response

Body

application/json

idstring

The users id

anonymousIdsarray

Any linked anonymous ids to the user

propertiesobject

All the properties you have inserted for the user

computedPropertiesobject

All the extended properties of the user generated by the platform

segmentsarray

All the keys of segments the user belongs to

locationDataobject

All location information associated with the user

deviceDataobject

All device information associated with the user

lastUpdatedAtnumber

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

createdAtnumber

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration-api.userflux.co/profile/{userId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "anonymousIds": [],
  "segments": [],
  "lastUpdatedAt": 0,
  "createdAt": 0
}