Amplitude · Schema

CohortUploadRequest

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name Type Description
name string The name of the cohort to create or update.
ids array Array of user_id or amplitude_id values to include in the cohort.
owner string The email address of the cohort owner.
existing_cohort_id string If provided, updates the existing cohort with this ID instead of creating a new one.
View JSON Schema on GitHub

JSON Schema

amplitude-cohortuploadrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CohortUploadRequest",
  "title": "CohortUploadRequest",
  "type": "object",
  "required": [
    "name",
    "ids"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the cohort to create or update."
    },
    "ids": {
      "type": "array",
      "description": "Array of user_id or amplitude_id values to include in the cohort.",
      "items": {
        "type": "string"
      }
    },
    "owner": {
      "type": "string",
      "description": "The email address of the cohort owner."
    },
    "existing_cohort_id": {
      "type": "string",
      "description": "If provided, updates the existing cohort with this ID instead of creating a new one."
    }
  }
}