Sign in

v1

latestOpenAPI 3.1.02026-07-262210674.8 KB
v2

Update cohort

This endpoint allows updating an existing cohort. Depending on the access level of the provided API key, it can update cohorts owned by the requesting workspace, or also by child workspaces below the requesting workspace in the organization hierarchy. Lookalike-based cohorts cannot be updated via the Cohort API.

Any top level fields for which no value is provided in the request body will remain unchanged. Optional fields (currently only description) can be deleted by explicitly specifying null as the value.

patch/v2/cohorts/{cohortId}

Path parameters

cohortIdstring required

Cohort UUID

Request body

namestring
descriptionstring nullable
{"stackTrail":"components:schemas:Json","oasType":"schema","type":"unknown"}
tagsstring[]
state'Enabled' | 'Disabled'

Response

Cohort in full (including query)

idstring required
codeinteger required
namestring required
descriptionstring
{"stackTrail":"components:schemas:Json","oasType":"schema","type":"unknown"}
tagsstring[]
state'Enabled' | 'Disabled' required
workspaceIdstring
createdAtstring date-time required
lastUpdatedAtstring date-time required