User identification

Use this REST resource to create new users or update the data of existing tracked users. Helpful when needing to update users in mass and batch update isn't an option. However, it's likely easier to send the majority of the data over the frontend via the user information object when Product Fruits

API domain: api.productfruits.com


Create or update user

Resource: POST /v1/identify
Body

{
    "user": {
        "username": "a-unique-user-identifier", // REQUIRED, must be unique
        "firstname": "", // optional
        "lastname": "", // optional
        "role": "", // optional
        "signUpAt": "2020-07-08T00:00:00", // optional, JSON Date/DateTime format must be used
        "props": { // optional custom properties
            "intCustomProp": 78878,
            "boolCustomProp": false,
            "stringCustomProp": "example",
            "arrayCustomProp": [1, 2, 3]
        }
    }
}

This endpoint upserts the given tracked user. Use it to sync user properties from your backend systems. This call can also trigger a real-time update of the Product Fruits content if the user is online.

Was this article helpful?