Create appointment

POST {{baseUrl}}/appointments?subdomain={{subdomain}}&location_id={{location_id}}&notify_patient=false

Request Params

HEADERS

RESPONSES

status: Created

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