---
updatedAt: 2025-11-07T16:20:57.000Z
agentTools:
  projectIndex: https://developers.heap.io/llms.txt
---

# 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](https://help.heap.io/analysis-examples/analysis-features/account-health-analysis/) guide.

Our Looker Actions integration allows you to quickly import property data into Heap. See the  [Looker Actions Integration guide](https://help.heap.io/integrations/other/looker-actions-integration/) to learn more.

If you're planning to [measure account health](https://help.heap.io/analysis-examples/analysis-features/account-health-analysis/) 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.

<HTMLBlock>{`
<div id="heapCustom">
  <strong>Did you find what you were looking for?</strong>
  <br>
  <a href="https://survey.nicereply.com/heap.api/docs/Add-Account-Properties?s=10">
  <img alt="Thumb up" src="https://survey.nicereply.com/trackmaili/thumb_10.png">
  </a>
  <a href="https://survey.nicereply.com/heap.api/docs/Add-Account-Properties?s=1">
    <img alt="Thumb down" src="https://survey.nicereply.com/trackmaili/thumb_1.png">
  </a>
</div>
`}</HTMLBlock>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "server-side-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://heapanalytics.com/"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/api/add_account_properties": {
      "post": {
        "summary": "Add Account Properties",
        "description": "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.\n\nYou 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](https://help.heap.io/analysis-examples/analysis-features/account-health-analysis/) guide.\n\nOur Looker Actions integration allows you to quickly import property data into Heap. See the  [Looker Actions Integration guide](https://help.heap.io/integrations/other/looker-actions-integration/) to learn more.",
        "operationId": "add-account-properties",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "app_id"
                ],
                "properties": {
                  "app_id": {
                    "type": "integer",
                    "description": "The environment ID corresponding to one of your environments.",
                    "format": "int32"
                  },
                  "account_id": {
                    "type": "string",
                    "description": "Used for single account updates only. An ID for this account."
                  },
                  "properties": {
                    "type": "string",
                    "description": "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.",
                    "format": "json"
                  },
                  "accounts": {
                    "type": "array",
                    "description": "Used for bulk updates only. A list of objects with `account_id` and `properties` keys.",
                    "items": {
                      "properties": {
                        "account_id": {
                          "type": "string"
                        },
                        "properties": {
                          "type": "object",
                          "properties": {
                            "example_name": {
                              "type": "string",
                              "default": "example_value"
                            }
                          }
                        }
                      },
                      "type": "object"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "OK%"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "error message"
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": [],
        "x-readme": {
          "code-samples": [
            {
              "language": "curl",
              "code": "curl -X POST https://heapanalytics.com/api/add_account_properties \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \n    \"app_id\": \"123456789\", \n    \"account_id\": \"Fake Company\",\n    \"properties\": {\n      \"is_in_good_standing\": \"true\",\n      \"revenue_potential\": \"123456\",\n      \"account_hq\": \"United Kingdom\",\n      \"subscription\": \"Monthly\"\n    }\n  }'\n",
              "name": "Single Account Update"
            },
            {
              "language": "curl",
              "code": "curl -X POST https://heapanalytics.com/api/add_account_properties \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \n    \"app_id\": \"123456789\",\n    \"accounts\": [{\n      \"account_id\": \"Fake Account\",\n      \"properties\": {\n        \"is_in_good_standing\": \"true\",\n        \"revenue_potential\": \"123456\",\n        \"account_hq\": \"United Kingdom\",\n        \"subscription\": \"Monthly\"\n      }\n    }, {\n      \"account_id\": \"Other Account\",\n      \"properties\": {\n        \"is_in_good_standing\": \"false\",\n        \"will_churn\": \"true\",\n        \"account_hq\": \"Germany\",\n        \"subscription\": \"Yearly\"\n      }\n    }] \n  }'\n",
              "name": "Bulk Account Updates"
            }
          ],
          "samples-languages": [
            "curl"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```