Skip to navigation
Synth API ReferenceCohorts

Cancel a cohort

Cancel a cohort: its queued patients at once, running ones when they finish. Canceled cohorts aren’t billed.

Authentication

AuthorizationBearer

An API key, or an OAuth 2.0 access token, with the synth:process scope.

Path parameters

cohort_idstringRequiredformat: "uuid"

Response

Successful Response
idstringformat: "uuid"
statusenum
Allowed values:
created_atdatetime
sizeinteger
Patients requested.
max_documentsinteger

Most documents the cohort can produce (size x documents per patient).

progressobject
Patients by status.
started_atdatetime or nullOptional
finished_atdatetime or nullOptional
errorobject or nullOptional
Why the cohort failed, if it did.
summaryobject or nullOptional
What was delivered, once succeeded.
resultslist of objectsOptional
Files ready to download.
results_expire_atdatetime or nullOptional
Files not downloaded by then are deleted.

Errors

401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error