v1

latestOpenAPI 3.1.02026-07-244010.8 KB

Add User Properties

This API allows you to attach custom properties to any identified users from your servers, such as Sign Up Date (in ISO8601 format), Total # Transactions Completed, or Total Dollars Spent. Note that Heap will create a new property if it doesn’t already exist, and will overwrite the previous property if one already exists with the same name.

Currently, heap.AddUserProperties calls cannot be named all casings of id (ID,Id,iD,id) as it clashes with internal variables.

Our Looker Actions integration allows you to quickly import property data into Heap. See the Looker Actions Integration guide to learn more.

post/api/add_user_properties

Request body

app_idstring required

The environment ID of your Main Production project.

identitystring required

An identity, typically corresponding to an existing user. If no such identity exists, then a new user will be created with that identity. Case-sensitive string, limited to 255 characters.

propertiesstring json

An object with key-value properties you want associated with the user. Each key and property must either be a number or string with fewer than 1024 characters.

Response

200

object required