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. If the identity does not exist in Heap, Heap will create it as a user but with no events. Once events come to the user with the same Identity, the two will be merged under one user profile.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The environment ID of your Main Production project.

string
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.

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.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json