API Reference

Amplitude Cohort Sync

Handle 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

POST

amplitude

cohorts

curl --request POST \
  --url https://api.example.com/v1/amplitude/cohorts \
  --header 'Content-Type: application/json' \
  --data '
{
  "batch": [
    {}
  ]
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json

Validates the basic structure of Amplitude cohort sync payloads

batch

Batch · object[]

required

Response

Successful Response

Aampe Property UpdateHandle property updates coming from Aampe identify calls. Expects data in the exact format needed for publishing.

⌘I

Amplitude Cohort Sync

curl --request POST \
  --url https://api.example.com/v1/amplitude/cohorts \
  --header 'Content-Type: application/json' \
  --data '
{
  "batch": [
    {}
  ]
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Content

Data Ingestion

Body

Response