Sign in

v1

latestOpenAPI 3.1.02026-07-17141136.0 KB
cohorts

Update cohort

Update an existing cohort's metadata and participant configuration.

Partial updates: Only provided fields are updated. Omit fields you don't want to change.

Note: The variableMap and stageUnlockMap cannot be modified via API - they are managed internally.

put/experiments/{experimentId}/cohorts/{cohortId}

Path parameters

experimentIdstring required

Experiment ID

cohortIdstring required

Cohort ID

Request body

namestring

Updated cohort name

descriptionstring

Updated description

Example request

{
  "participantConfig": {
    "minParticipantsPerCohort": 1,
    "maxParticipantsPerCohort": 10,
    "showStageDescriptions": true
  }
}

Response

Cohort updated successfully

updatedboolean
idstring

Example response

{
  "updated": true,
  "id": "cohort123"
}