# Create Cohort — Amplitude

> Create a static cohort in Amplitude from an explicit list of user or Amplitude IDs via POST /api/3/cohorts/upload (the only REST-documented cohort creation endpoint; behavioral/dynamic cohorts cannot be created via REST). Use List Cohorts…

- Key: `amplitude-create-cohort`
- Type: Action (Write)
- Version: 0.0.2
- App: Amplitude (`amplitude`) — https://pipedream.com/apps/amplitude.md
- This page (HTML): https://pipedream.com/apps/amplitude/actions/create-cohort
- Hints: destructive · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/amplitude/actions/create-cohort/create-cohort.mjs

## Description

Create a static cohort in Amplitude from an explicit list of user or Amplitude IDs via `POST /api/3/cohorts/upload` (the only REST-documented cohort creation endpoint; behavioral/dynamic cohorts cannot be created via REST). Use **List Cohorts** to find an existing cohort ID if updating. Example: call with `cohortName="Power Users Q3"`, `appId=849238`, `idType="BY_USER_ID"`, `ids=["user@example.com"]`, `owner="admin@example.com"` -> returns `{cohortId: "abc123"}`. [See the documentation](https://amplitude.com/docs/apis/analytics/behavioral-cohorts#upload-cohort).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `cohortName` | `string` | Yes | Name of the cohort (the name field). Example: Power Users Q3. |
| `appId` | `integer` | Yes | The numeric Amplitude project ID that owns the cohort (the app_id field). This isn't retrievable through any Amplitude REST API — find it in Amplitude under Settings > Projects, or in the project's Getting Started page. Example: 849238. |
| `idType` | `string` | Yes | The type of identifiers provided in Ids (the id_type field). One of BY_AMP_ID, BY_USER_ID. |
| `ids` | `string[]` | Yes | Array of user or Amplitude IDs to include in the cohort (the ids field), matching the chosen ID Type. Example: ["12345678","87654321"]. |
| `owner` | `string` | Yes | Login email of the cohort owner (the owner field). Example: user@example.com. |
| `published` | `boolean` | No | Whether the cohort is published/shared (the published field). |
| `groupName` | `string` | No | Optional group name for the cohort (the cg field). |
| `skipInvalidIds` | `boolean` | No | When true, silently skip IDs that cannot be resolved instead of failing (the skip_invalid_ids field). |
| `existingCohortId` | `string` | No | Optional ID of an existing cohort to overwrite instead of creating a new one (the existing_cohort_id field). Use List Cohorts to find valid cohort IDs. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "amplitude",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "amplitude-create-cohort",
  arguments: {
    cohortName: "Name",
    appId: 10,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "amplitude-create-cohort",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    amplitude: { authProvisionId: "apn_xxxxxxx" },
    cohortName: "Name",
    appId: 10,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "amplitude-create-cohort",
    "configured_props": {
      "amplitude": { "authProvisionId": "apn_xxxxxxx" },
      "cohortName": "Name",
      "appId": 10
    }
  }'
```

---

- App: https://pipedream.com/apps/amplitude.md · All apps: https://pipedream.com/apps