Skip to main content
PATCH
Update Cohort
For more information, see the guide about Cohorts

Path Params

string
required
The ID of the cohort to update.

Headers

string
The ETag value for optimistic concurrency control. If provided, the update will only succeed if the current ETag matches this value.

Body

All fields are optional for updates. The API performs partial updates:
  • Omitted fields remain unchanged - only include fields you want to modify
  • To update a field - simply include the new value
string
The name of the cohort. The name must be unique within your organization.
string
The color associated with the cohort. Must be one of: red, green, blue, yellow, purple, orange, pink, brown, gray, black, white. Defaults to white on creation if no color is given.
string
A description of the cohort and its purpose.

Examples

Partial update example:
In this example, only the name field is updated. All other fields remain unchanged. Clearing fields example:
This removes the description and leaves the rest of the details the same.

Response

string
required
The unique identifier for the cohort (UUID format, e.g., 00000000-0000-0000-0000-000000000000).
string
required
The entity tag for optimistic concurrency control.
string
required
The unique name of the cohort within your organization.
string
required
The description of the cohort.
string
required
The color associated with the cohort.
object
required
Configuration settings for the cohort.
number
required
The number of patients assigned to this cohort.