Skip to Content

POST /cohort/update

Update Cohort

Update cohorts using composable infra architecture.

Request Body (UpdateCohortApiRequest)

FieldTypeRequiredDescription
cohortsUpdateCohortItem[]NoList of cohorts to update (required on first call when all is false)
allbooleanNoWhen true, apply patch to every cohort matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
patchUpdateCohortPatchNoShared change set applied to every matched row when all=true (sparse — only set fields are updated; patch.id ignored)
searchstringNoFull-text search query
filter_profile_idsstring[]NoFilter by profile UUIDs
filter_simulation_idsstring[]NoFilter by simulation UUIDs
filter_department_idsstring[]NoFilter by department UUIDs
profile_searchstringNoSearch text for profile facet (no-op for row filtering)
simulation_searchstringNoSearch text for simulation facet (no-op for row filtering)
department_searchstringNoSearch text for department facet (no-op for row filtering)
flag_searchstringNoSearch text for flag facet (no-op for row filtering)
idempotency_keystringNoOperation key for ack — promotes or rejects a dormant update
softbooleanNoStage the update dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (promote) or reject dormant state. Only meaningful with idempotency_key

Response (UpdateCohortApiResponse)

FieldTypeRequiredDescription
resultsCohortResultItem[]YesList of operation results
idempotency_keystringNoIdempotency key echoed back for client correlation
Last updated on