---
title: "Edit Appointment"
method: PATCH
path: "/appointments/{id}"
tags: ["Appointments"]
---

# Edit Appointment

`PATCH /appointments/{id}`

This endpoint updates an existing appointment.

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required

## Headers

- `Nex-Api-Version` string, required

## Request body

- PatchAppointmentsId — Edit Appointment
  - `appt` object, required — Appointment detail object
    - `confirmed` boolean — Denotes the office has confirmed the appt, update this to write back confirm status
    - `cancelled` boolean — Denotes the office has cancelled the appt, update this to write back cancel status
    - `checkin_at` string, date-time — Denotes the office has checked in the appt at this time, update this to write back checked in status. Must be a parseable date/time string, recommended format is YYYY-MM-DDThh:mm:ss+0000
    - `start_time` string, date-time — Appointment start time. Must be a parseable date/time string. Recommended format is YYYY-MM-DDThh:mm:ss+0000.
    - `end_time` string, date-time — Appointment end time. Must be a parseable date/time string. Recommended format is YYYY-MM-DDThh:mm:ss+0000.
    - `operatory_id` integer — The operatory for this appointment
    - `note` string — A note that will be written to the EHR

## Response `200`

Successful

- APIV2EntitiesAppointmentResponseResponse — API_V2_Entities_AppointmentResponse_Response model
  - `code` boolean — Indicates the success or failure of the request
  - `description` string — Additional context on the request to help with debugging.
  - `error` string[] — Any errors that occur during the execution of the request.
  - `data` APIV2EntitiesAppointmentResponse
    - `appt` APIV2EntitiesAppointmentWithoutIncludes
      - `id` integer — Appointment id
      - `patient_id` integer, nullable — Appointment patient id
      - `provider_id` integer, nullable — Provider id
      - `provider_name` string, nullable — Provider name
      - `start_time` string, date-time — Appointment scheduled start time in UTC
      - `confirmed` boolean, nullable — Appointment confirmation status
      - `patient_missed` boolean, nullable — Did the patient no show? Not supported by all integrations
      - `created_at` string, date-time — Appointment created time in UTC
      - `updated_at` string, date-time — Appointment last updation time in UTC
      - `note` string, nullable — Appointment note
      - `end_time` string, date-time — Appointment scheduled end time in UTC
      - `unavailable` boolean, nullable — Is this appointment a scheduling block (blocks off the schedule)
      - `cancelled` boolean — Is this appointment cancelled?
      - `timezone` string — Appointment timezone
      - `institution_id` integer — Institution id
      - `appointment_type_id` integer, nullable — Nexhealth appointment_type id, 0 if not set
      - `checkin_at` string, date-time, nullable — Time the patient checked in at in UTC. Not supported by all integrations
      - `location_id` integer, nullable — Appointment location id
      - `foreign_id` string, nullable — Unique identifier of this resource from the integrated system
      - `foreign_id_type` string — Unique identifier for the integrated system itself
      - `misc` object, nullable — Miscellaneous information for the appointment. The is_booked_on_nexhealth key indicates whether the appointment was booked through NexHealth
      - `last_sync_time` string, date-time, nullable — Last Sync time in UTC
      - `patient_confirmed` boolean, nullable — Is this appointment confirmed by the patient (as opposed to the office)?
      - `created_by_user_id` integer, nullable — Id of the user who booked the appointment
      - `is_guardian` boolean, nullable — Was the appointment booked by a guardian?
      - `patient_confirmed_at` string, date-time, nullable — Time of patient_confirmation in UTC
      - `cancelled_at` string, date-time, nullable — Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled
      - `is_new_clients_patient` boolean, nullable — Is this a new patient at this practice?
      - `confirmed_at` string, date-time, nullable — Time of appointment confirmation by the office in UTC
      - `sooner_if_possible` boolean, nullable — Does patient want an earlier time?
      - `operatory_id` integer, nullable — Operatory id for the appointment
      - `checked_out` boolean, nullable — Has the patient checked out? Not supported by all integrations
      - `checked_out_at` string, date-time, nullable — Time of check out in UTC
      - `referrer` string, nullable — Optional field to store URI origin of the booking
      - `is_past_patient` boolean, nullable — Does this patient have prior appointments?
      - `timezone_offset` string — Timezone offset string
    - `stripe_client_secret` string
  - `count` integer — Number of total objects, in case of collection.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)