Skip to main content
POST
/
v1
/
properties
Aampe Property Update
curl --request POST \
  --url https://ingestion.{region}.api.aampe.com/v1/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "<string>",
  "timestamp": 123,
  "user_properties": {},
  "event_name": "<string>",
  "event_id": "<string>",
  "metadata": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://kb.aampe.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Additional metadata dictionary for the event

Response

Successful Response