Add Account Properties

This API allows you to attach custom account properties to users. An account ID or use of our Salesforce integration is required for this to work. Note that, as your set of accounts and their properties change, you’ll need to periodically call this API with an account ID as well as any account-level properties.

You will need to configure the Account ID setting before using this API to send your account data into Heap. Instructions to complete this and all of the other steps to analyze account data are available in the Account Health Analysis guide.

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…

If you're planning to measure account health in Heap, you should use this endpoint to send useful account properties for analysis (e.g. payment tier, account owner, account name, etc). This endpoint can be used for either a single account, or multiple accounts at once.

🚧

If your Heap data is in an EU datacenter, the correct endpoint is:

https://c.eu.heap-api.com/api/add_account_properties (NOT heapanalytics.com)

❗️

Limitations

Please note: fetch, jQuery, and XMLHttpRequest options are not currently supported.

Did you find what you were looking for?
Thumb up Thumb down
Body Params
int32
required

The environment ID corresponding to one of your environments.

string

Used for single account updates only. An ID for this account.

json

Used for single account updates only. An object with key-value properties you want associated with the account. Each key and property must either be a number or a string with fewer than 1024 characters.

accounts
array of objects

Used for bulk updates only. A list of objects with account_id and properties keys.

accounts
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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