For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
          • POSTCreate
          • POSTCreate With Mrn
          • GETGet Multi
          • GETSearch Providers
          • GETGet
          • GETGet By Mrn
          • GETGet History
          • GETGet Coverage Snapshot
          • PUTUpdate
          • DELDeactivate
          • PATCHReactivate
          • GETSearch
          • GETScan
Contact Sales
LogoLogo
API ReferencePre EncounterPatientsV1

Deactivate

Beta
DELETE
/patients/v1/:id/:version
DELETE
/patients/v1/:id/:version
$curl -X DELETE https://pre-api.joincandidhealth.com/patients/v1/id/version \
>     -H "Authorization: Bearer <token>"
Sets a patient as deactivated. The path must contain the most recent version plus 1 to prevent race conditions. Deactivating historic versions is not supported.
Was this page helpful?
Previous

Reactivate

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequired
The unique identifier for a Patient
versionstringRequired

Errors

404
Not Found Error
409
Version Conflict Error