Skip to main content
POST
Aampe Property Update

Authorizations

Authorization
string
header
required

Your Ingestion API key. Obtain from Integrations > API keys in the Aampe Dashboard. See Authentication for details.

Body

application/json

Represents a property update event for a user.

Note on serialization: Downstream consumers expect user_properties and (when present) metadata to be JSON-encoded strings inside the outer JSON payload. We implement this via Pydantic field serializers so callers can keep using native dicts in Python.

contact_id
string
required

The user's ID

timestamp
number
required

Unix epoch seconds (number); decimals and millisecond values supported.

user_properties
User Properties · object
required

Dictionary of property names to values

event_name
string | null

Custom suffix for the event name. Will be appended to 'aampe_property_update_'

event_id
string | null

Optional unique ID of the event

metadata
Metadata · object | null

Additional metadata dictionary for the event

Response

Successful Response