Remove patients from cohort

DELETE

cohorts

{cohort_id}

patients

import olira

olira.init(api_key="YOUR_API_KEY")
result = olira.remove_patients_from_cohort(
    cohort_id="68582e4a0a0b3c1234567890",
    patient_ids=["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"],
)
print(result.patient_count)

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.RemovePatientsFromCohort(
    cohortId: "68582e4a0a0b3c1234567890",
    patientIds: ["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"]);
Console.WriteLine(result.PatientCount);

DELETE /v1/cohorts/68582e4a0a0b3c1234567890/patients
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "patient_ids": ["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"]
}

CohortPatientMutationResult(cohort_id="68582e4a0a0b3c1234567890", patient_count=0)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

olira.remove_patients_from_cohort(
    cohort_id: str,
    patient_ids: list[str],
) -> CohortPatientMutationResult

OliraModule.RemovePatientsFromCohort(
    string cohortId,
    IReadOnlyList<string> patientIds,
)  // -> CohortPatientMutationResult

Requires scope: api:manage-patients Max 500 per call. Patient records are not affected.

Parameters

str

required

Olira-assigned cohort id.

list[str]

required

Olira patient ids to remove (max 500).

Returns

CohortPatientMutationResult

str

Cohort id.

int

Total enrolled patients after the operation.

Raises

Exception	When
`AuthError`	HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
`ValidationError`	HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).
`ServerError`	HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
`RateLimitError`	HTTP 429 — rate limited; check retry_after (seconds).
`NetworkError`	Connection timeout, DNS failure, or read error after retries.

import olira

olira.init(api_key="YOUR_API_KEY")
result = olira.remove_patients_from_cohort(
    cohort_id="68582e4a0a0b3c1234567890",
    patient_ids=["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"],
)
print(result.patient_count)

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.RemovePatientsFromCohort(
    cohortId: "68582e4a0a0b3c1234567890",
    patientIds: ["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"]);
Console.WriteLine(result.PatientCount);

DELETE /v1/cohorts/68582e4a0a0b3c1234567890/patients
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "patient_ids": ["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"]
}

CohortPatientMutationResult(cohort_id="68582e4a0a0b3c1234567890", patient_count=0)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

import olira

olira.init(api_key="YOUR_API_KEY")
result = olira.remove_patients_from_cohort(
    cohort_id="68582e4a0a0b3c1234567890",
    patient_ids=["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"],
)
print(result.patient_count)

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.RemovePatientsFromCohort(
    cohortId: "68582e4a0a0b3c1234567890",
    patientIds: ["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"]);
Console.WriteLine(result.PatientCount);

DELETE /v1/cohorts/68582e4a0a0b3c1234567890/patients
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "patient_ids": ["8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82"]
}

CohortPatientMutationResult(cohort_id="68582e4a0a0b3c1234567890", patient_count=0)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

Log types

SDK

Remove patients from cohort

Parameters

Returns

Raises

​Parameters

​Returns

​Raises

Parameters

Returns

Raises