Skip to main content
DELETE
/
v1
/
cohorts
/
{cohort_id}
import olira

olira.init(api_key="YOUR_API_KEY")
result = olira.delete_cohort(cohort_id="68582e4a0a0b3c1234567890")
print(result.deleted)  # True

CohortDeleteResult(deleted=True, cohort_id="68582e4a0a0b3c1234567890")

olira.delete_cohort(cohort_id: str) -> CohortDeleteResult
Requires scope: api:manage-patients Patient records are not affected.

​
Parameters

​
cohort_id
str
required
Olira-assigned cohort id.

​
Returns

CohortDeleteResult
​
deleted
bool
Always true on success.
​
cohort_id
str
Id of the deleted cohort.

​
Raises

ExceptionWhen
AuthErrorHTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
ValidationErrorHTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).
ServerErrorHTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
RateLimitErrorHTTP 429 — rate limited; check retry_after (seconds).
NetworkErrorConnection timeout, DNS failure, or read error after retries.
import olira

olira.init(api_key="YOUR_API_KEY")
result = olira.delete_cohort(cohort_id="68582e4a0a0b3c1234567890")
print(result.deleted)  # True

CohortDeleteResult(deleted=True, cohort_id="68582e4a0a0b3c1234567890")