Add people to a cohort
Adds people to a static cohort, by person id, distinct id or email; people already in it stay as they are.
Identifiers no current person of the project has are returned in unresolved.
Guide: Cohorts
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
The cohort's id, an_cohort_....
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
Examples
curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts/an_cohort_m2x7c1q8w4e6r0t5y2u8k3v9/people" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "distinctIds": [ "user_8231" ], "emails": [ "grace@example.com" ] }'{ "cohort": { "id": "an_cohort_m2x7c1q8w4e6r0t5y2u8k3v9", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Beta testers", "description": null, "kind": "static", "definition": null, "memberCount": 1, "createdAt": "2026-03-05T12:00:00.000Z", "updatedAt": "2026-03-14T09:26:53.000Z" }, "added": 1, "unresolved": [ "grace@example.com" ]}{ "error": { "type": "invalid_request", "code": "invalid_analytics_cohort", "message": "Cohorts name each other in a circle: Power users names Lapsed, which names Power users." }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}{ "error": { "type": "unavailable", "code": "string", "message": "string", "param": "string" }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_analytics_cohort | For a dynamic cohort. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Cohorts
- List cohorts
GET - Create a cohort
POST - Preview a cohort definition
POST - Retrieve a cohort
GET - Update a cohort
PATCH - Delete a cohort
DELETE - List a cohort's people
GET - Remove a person from a cohort
DELETE
Something wrong or missing on this page? Tell us by email or on Discord.