Skip to main content
POST
/
v1
/
properties
Aampe Property Update
curl --request POST \
  --url https://api.example.com/v1/properties \
  --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>"
    }
  ]
}

Body

application/json

Represents a property update event for a user. Data format matches both input and output requirements.

​
contact_id
string
required

The user's ID

​
timestamp
required

Unix timestamp of update

​
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