Record user properties

Enhance user engagement with the Record User Properties API.

Capture detailed user attributes to fuel personalised experiences and improve cohort analysis on the BIK dashboard. Efficiently store and utilise user data to drive informed strategies, similar to our 'Send Events API' for event tracking. Ideal for developers and marketers aiming for deeper user insights.

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-createOrUpdateUserProperties' \
--header 'Authorization: Basic AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "APP_ID",
    "userProperties": [
        {
            "phoneNumber": "9090909090",
            "email": "mark@bik.ai",
            "firstName": "Test",
            "lastName": "2"
        },
        {
            "phoneNumber": "9090909010",
            "emial": "mark2@bik.ai",
            "firstName": "Test2",
            "lastName": "4"
        }
    ]
}'

JSON response example:

{
  "status": 200,
  "data": {
    "invalidUserProperties": [
      {
        "phoneNumber": "9090909010",
        "emil": "mark2@bik.ai",
        "firstName": "Test2",
        "lastName": "4",
        "storeId": "p60HYv5wjgQaOrPdqT5NjbpkroD2",
        "customerId": "5242031",
        "error": "ValidationError: \"emil\" is not allowed"
      }
    ],
    "bulkUpsertUPResponse": {
      "createCount": 0,
      "updateCount": 1,
      "docsFailedToUpdate": []
    }
  }
}

Request Information

Category	Value
Http request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-createOrUpdateUserProperties

Input Schema for request

Field	Type	Meaning
appId	string*	Application id of the store
userProperties	UserProperty object[]*	list of user properties

Output Schema for request

Field	Type	Meaning
status	boolean	RecordUserProperties status
data	RecordUserProperties object	RecordUserProperties response if any