JOjoincandidhealth
v1

Deactivate

Changed on

Sets an appointment as deactivated. The path must contain the most recent version to prevent race conditions. Deactivating historic versions is not supported. Subsequent updates via PUT to the appointment will "reactivate" the appointment, set the deactivated flag to false, and clear the cancellation reason.

delete/appointments/v1/{id}/{version}

Request

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

Path parameters

idstring required

The unique identifier for an Appointment.

versionstring required

Query parameters

cancellation_reasonstring

The reason the appointment is being cancelled.

Response

Successful response

Changes

  • 4074901c170fRevision changes
    • info

      added the new optional query request parameter cancellation_reason

  • 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