Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heap Add User Properties API

The Add User Properties API from Heap — 1 operation(s) for add user properties.

Heap Add User Properties API is one of 10 APIs that Heap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Add User Properties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://heapanalytics.com.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://heapanalytics.com
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Add User Properties 1
POST
/api/add_user_properties
Add user properties
addUserProperties body → 200400

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is AddUserPropertiesRequest (3 properties). Each schema is shown below with its type and property counts.

AddUserPropertiesRequest
object
3 properties 2 required
Properties
object
Key-value pairs of properties. Keys and string values must be under 1024 characters; values may be strings or numbers.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heap-add-user-properties-api-openapi.yml Raw ↑

Other APIs Heap publishes across the network.

Heap Server-Side API
Heap Track API
Heap Identify API
Heap Add User Properties API
Heap Add Account Properties API
Heap Add Account Properties API
Heap Identify API
Heap Track API
Heap Webhooks API