Update a cohort

Renames a cohort, changes its description, or gives a dynamic cohort a new definition.

A static cohort's people change with addPeople and removePerson. Its kind never changes.

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Cohorts

Something wrong or missing on this page? Tell us by email or on Discord.

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

cohortId*string

The cohort's id, an_cohort_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

name?|

The new name, 1 to 255 characters.

description?||

The new description; null removes it.

definition?|

A dynamic cohort's new definition. Not allowed for a static one.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts/an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Committed athletes"  }'

{  "id": "an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Committed athletes",  "description": "Finished three workouts in the last 30 days.",  "kind": "dynamic",  "definition": {    "match": "all",    "conditions": [      {        "kind": "performed",        "event": "workout_completed",        "isNegated": false,        "count": {          "op": "gte",          "value": 3        },        "withinDays": 30,        "filters": []      }    ]  },  "memberCount": 128,  "createdAt": "2026-03-05T12:00:00.000Z",  "updatedAt": "2026-03-05T12:00:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Expected object"  }}

{  "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"  }}

Update a cohort

Errors

More in Cohorts

Update a cohort

Errors

More in Cohorts

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update a cohort

Update a cohort

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`