Skip to main content

​
Schema

PropertyTypeDescription
idIDThe Chameleon ID
created_attimestampWhen this happened or when this was added to the Database
updated_attimestampThe last time any property was updated
namestringThe name given by an administrator of Chameleon
descriptionstringThe display description
kindstringType of record this property is associated with: One of profile, event, or company
propstringThe normalized property key
integrationstringThe source integration of this property
last_seen_attimestampThe time when this property was last added to / removed from a User Profile.
typesarrayThe identified type of property values seen (string, integer etc.)
valuesarrayA sample of the most recent values seen for this property (most recent first).

​
Listing Properties

Retrieve a complete (un-paginated) list of properties for the given kind + integration.

​
HTTP Request

GET https://api.chameleon.io/v3/edit/properties
param-description
kindrequiredUse a values of either profile or company
integrationoptionalUsed to filter properties to only ones created by a specific integration. Omit for “all integrations”.
orderoptionalOne of created_at or last_seen_at, ordered by most recent. Defaults to created_at.
Custom User Profile properties 
{
  "kind": "profile",
  "integration": "api",
  "order": "last_seen_at"
}
Salesforce Company properties 
{
  "kind": "company",
  "integration": "salesforce"
}

​
HTTP Response

{
  "properties": [
    {
      "id": "5f3c4232c712de665632a6d9",
      "name": "Monthly plan value (dollars USD)",
      "prop": "plan_cost",
      "types": ["integer"],
      "values": [678, 442, 1218, 239, 394],
      "last_seen_at": "2029-04-07T12:18:00Z"
    },
    {
      "id": "5f3c4232c712de665632a6e2",
      "name": "Lifetime value",
      ...
    },
    ...
  ]
}

​
Create a Property

​
HTTP Request

POST https://api.chameleon.io/v3/edit/properties
param-typedescription
namerequiredstringThe name given by an administrator of Chameleon
descriptionrequiredstringThe display description
kindrequiredstringType of record this property is associated with: One of profile, event, or company
{
  "name": "Next invoice date",
  "description": "The next time an Invoice will be generated by QBO",
  "kind": "company",
  ...
}

​
HTTP Response

{
  "property": {
    "id": "5f3c4232c712de665632a6d5",
    "created_at": "2029-02-03T00:00:00Z",
    "name": "Next invoice date",
    "description": "The next time an Invoice will be generated by QBO",
    "kind": "company",
    "prop": "next_invoice_date",
    ...
  }
}

​
Update a Property

​
HTTP Request

PUT|PATCH https://api.chameleon.io/v3/edit/properties/:id
paramtypedescription
idstringThe ID of the Property
namestringThe name given by an administrator of Chameleon
descriptionstringThe display description
{
  "description": "The next time an Invoice will be generated by Stripe",
  ...
}