Amplitude ACTION
Create Cohort
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.- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Amplitude account once, then configure and run Create Cohort from your backend or agent.
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 -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
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
cohortName Name | string | Name of the cohort (the name field). Example: Power Users Q3. Required |
appId App ID | integer | 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. Required |
idType ID Type | string | The type of identifiers provided in Ids (the id_type field). One of BY_AMP_ID, BY_USER_ID. Required |
ids IDs | string[] | Array of user or Amplitude IDs to include in the cohort (the ids field), matching the chosen ID Type. Example: ["12345678","87654321"]. Required |
owner Owner | string | Login email of the cohort owner (the owner field). Example: user@example.com. Required |
published Published | boolean | Whether the cohort is published/shared (the published field). Optional |
groupName Group Name | string | Optional group name for the cohort (the cg field). Optional |
skipInvalidIds Skip Invalid IDs | boolean | When true, silently skip IDs that cannot be resolved instead of failing (the skip_invalid_ids field). Optional |
existingCohortId Existing Cohort ID | string | 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. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- amplitude-create-cohort
- Version
- 0.0.2
- App
- Amplitude
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗