Aampe Property Update - Aampe Docs

POST

/

v1

/

properties

"<any>"

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

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

object | null

Additional metadata dictionary for the event

Response

Successful Response

The response is of type any.

Amplitude Cohort SyncHandle cohort updates from Amplitude webhooks in Segment batch format. Each item in the batch has traits indicating property updates. Expected payload format: { "batch": [{ "type": "identify", "traits": { "[Amplitude] {cohort_name}: {cohort_id}": true }, "userId": "user123", "context": { "integration": { "name": "Amplitude Cohort Sync", "version": "1.0.0" } } }] } Trait name format: "[Amplitude] {cohort_name}: {cohort_id}" Trait value: boolean indicating cohort membership Invalid users in the payload will be skipped and logged, but won't fail the entire request as long as at least one user is valid. See: https://amplitude.com/docs/partners/create-a-cohort-syncing-integration

⌘I

"<any>"