patch Appointments Id

PATCH {{baseUrl}}/appointments/:id?subdomain={{subdomain}}

Update an appointment.

Request Params

KeyDatatypeRequiredDescription
subdomainstring(Required) Used to scope the request to the specified institution

Request Body

{"appt"=>{"patient_id"=>"<integer>", "provider_id"=>"<integer>", "operatory_id"=>"<integer>", "start_time"=>"<dateTime>", "confirmed"=>"<boolean>", "cancelled"=>"<boolean>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;code&quot;:&quot;\u003cboolean\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;error&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;data&quot;:{&quot;appt&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;start_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;confirmed&quot;:&quot;\u003cboolean\u003e&quot;,&quot;patient_missed&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;note&quot;:&quot;\u003cinteger\u003e&quot;,&quot;end_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;unavailable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;cancelled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;appointment_type_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;checkin_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;misc&quot;:&quot;\u003cobject\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_confirmed&quot;:&quot;\u003cinteger\u003e&quot;,&quot;created_by_user_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;is_guardian&quot;:&quot;\u003cboolean\u003e&quot;,&quot;patient_confirmed_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;cancelled_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_new_clients_patient&quot;:&quot;\u003cboolean\u003e&quot;,&quot;confirmed_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;sooner_if_possible&quot;:&quot;\u003cstring\u003e&quot;,&quot;operatory_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;deleted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;checked_out&quot;:&quot;\u003cboolean\u003e&quot;,&quot;checked_out_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;referrer&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_past_patient&quot;:&quot;\u003cboolean\u003e&quot;,&quot;timezone_offset&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;middle_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;bio&quot;:&quot;\u003cobject\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;guarantor_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;unsubscribe_sms&quot;:&quot;\u003cboolean\u003e&quot;},&quot;procedures&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;appointment_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;fee&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;start_date&quot;:&quot;\u003cdate\u003e&quot;,&quot;end_date&quot;:&quot;\u003cdate\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;appointment_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;fee&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;start_date&quot;:&quot;\u003cdate\u003e&quot;,&quot;end_date&quot;:&quot;\u003cdate\u003e&quot;}],&quot;descriptors&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;descriptor_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;data&quot;:&quot;\u003cobject\u003e&quot;,&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;descriptor_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;data&quot;:&quot;\u003cobject\u003e&quot;,&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;}],&quot;booking_details&quot;:{&quot;booked_via_nexhealth_generated_link&quot;:&quot;\u003cboolean\u003e&quot;,&quot;campaign_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;campaign_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;campaign_medium&quot;:&quot;\u003cstring\u003e&quot;,&quot;booked_via_one_click&quot;:&quot;\u003cboolean\u003e&quot;}}},&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}