Skip to Content

POST /cohort/delete

Delete Cohort

Bulk delete cohorts — composable infra architecture.

Request Body (DeleteCohortApiRequest)

FieldTypeRequiredDescription
cohort_idsstring[]NoCohort UUIDs to delete (required on first call when all is false)
allbooleanNoWhen true, delete every cohort matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
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 — confirms or rejects a dormant delete
softbooleanNoStage the delete dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (confirm deletion) or reject (restore). Only meaningful with idempotency_key

Response (DeleteCohortApiResponse)

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