v1

latestOpenAPI 3.1.02026-07-244010.8 KB

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.

post/api/add_account_properties

Request body

app_idinteger required

The environment ID corresponding to one of your environments.

account_idstring

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

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

Response

200