User Profiles (Incoming Webhook)

Profile data updates are processed synchronously on the application server.

​

Create/Update a Profile

• When you are creating the User Profile, send the User ID as uid and any other properties pertinent to that Profile.
• When you are updating the User Profile, send the User ID as uid, the Email address as email or the Chameleon ID as id and any other properties pertinent to that Profile.

​

HTTP Request

https://api.chameleon.io/v3/observe/hooks/profiles

https://api.chameleon.io/v3/observe/hooks/:account_secret/profiles

{
  "uid": 18821,
  "email": "leon@chmln.co",
  "first_name": "Leon",
  "role": "admin",
  "last_import_at": "2029-04-07T12:18:00Z",
  "invited_users_count": 4,
   ...
}

{
  "uid": 18821,
  "role": "admin",
  "company_uid": 931
}

​

HTTP Response

{
  "profile": {
    "id": "5f3c4232c712de665632a2a3"
  }
}

​

Disabling all Chameleon Experiences

​

Limits

• Up to a total of 768 bytes are stored for each scalar value where each Array item and each Hash value can reach this limit.
• See the full page on Normalization for more information on these limits.

​

Normalization

• Property names are normalized to lower case and underscored i.e. userRole => user_role.
• See the full page on Normalization for more information on how properties are normalized.

​

Bulk Create/Update Profiles

• When sending a bulk create/update send an array of User Profile objects as the profiles parameter
• For each User Profile, send the User ID as uid and any other properties pertinent to that Profile.
• Instead of the uid you may use the Email address as email.

​

HTTP Request

https://api.chameleon.io/v3/observe/hooks/profiles/batch

https://api.chameleon.io/v3/observe/hooks/:account_secret/profiles/batch

{
  "profiles": [
    {
      "uid": 18821,
      "first_name": "Leon",
      "role": "admin",
      "last_import_at": "2029-04-07T12:18:00Z",
      "invited_users_count": 7,
      ...
    },
    {
      "uid": 28421,
      "first_name": "Kim",
      "role": "engineer",
      "last_import_at": "2029-04-02T16:11:06Z",
      "invited_users_count": 4,
      ...
    },
    ...
  ]
}

{
  "profiles": [
    {
      "uid": 18821,
      "company_uid": 931
    },
    {
      "uid": 28421,
      "company_uid": 632
    },
    ...
  ]
}

​

HTTP Response

{
  "batch": {
    "id": "7f332c712de6c4265632a32a"
  }
}

​

HTTP Response error

{
  "batch": {
    "id": "7f332c712de6c4265632a32a"
  },
  "errors": [
    {
      "code": 422,
      "index": 4429,
      "message": "No identifier found for the 4430th item. Pass your User ID as the `uid` parameter or the Email address as the `email` parameter"
    }
  ]
}

​

Limits

• The size of each batch request is limited to 16mb
• As with the Single Profile update, up to a total of 768 bytes are stored for each scalar value where each Array item and each Hash value can reach this limit.
• See the full page on Normalization for more information on these limits.

​

Examples

Either set the number of items per batch to 10,000 OR to approximate the number of items per batch (based on the average payload size), divide (16777216 / “Average characters in JSON payload per item”) * 0.95

{
  "uid": "49573fa9-f111-4644-8c24-e41520ee87e2",
  "plan": "gold"
}

{
  "uid": "49573fa9-f111-4644-8c24-e41520ee87e2",
  "email": "jane@acme.ai",
  "first_name": "Jane",
  "last_name": "Chameleon",
  "last_login": "2029-04-29T09:00:00.000Z",
  "subscription_type": "platinum",
  "role": "revops",
  "company_id": "72d8ce91-fa3c-40f4-954d-4a8e8319a61e"
}

​

HTTP Response error

{
  "code": 413,
  "messages": ["Each batch must be less than 16mb, try splitting the batch in half"]
}