JOjoincandidhealth
v1

Deactivate

Changed on

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.

delete/patients/v1/{id}/{version}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/patients/v1/{id}/{version}
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique identifier for a Patient

versionstring required

Response

Successful response

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      for the path request parameter id, the type was generalized from no type to string

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id deactivate removed and replaced with v1_deactivate_7