v1

latestOpenAPI 3.0.22026-07-2414318.0 KB

appointments

Update a resource.

patch/practices/{practice_id}/appointments/{appointments}

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

appointmentsstring required

Resource Identifier

Request body

appointment_typestring required

billing_provider_npistring

If provided, Collectly will look up imported providers by NPI instead of external_id. Do not provide both 'external_billing_provider_id' and 'billing_provider_npi'.

{"stackTrail":"components:schemas:Appointment:properties:client_id","oasType":"schema","type":"unknown"}

collectly_patient_idinteger

collectly_primary_insurance_policy_idinteger

collectly_secondary_insurance_policy_idinteger

{"stackTrail":"components:schemas:Appointment:properties:company_id","oasType":"schema","type":"unknown"}

created_atstring date-time

{"stackTrail":"components:schemas:Appointment:properties:expected_copay_amount","oasType":"schema","type":"unknown"}

external_billing_provider_idstring

external_billing_provider_namestring

If provided, Collectly will look up imported providers by name instead of external_id. Do not provide both 'external_billing_provider_id' and 'external_billing_provider_name'.

external_idstring required

external_location_idstring

external_location_namestring

If provided, Collectly will look up imported locations by name instead of external_id. Do not provide both 'external_location_id' and 'external_location_name'.

external_patient_idstring

external_provider_idstring

external_provider_namestring

If provided, Collectly will look up imported providers by name instead of external_id. Do not provide both 'external_provider_id' and 'external_provider_name'.

external_status'active' | 'cancelled' | 'rescheduled' | 'no_show' required

idinteger

metadataobject

Additional data to be stored with the appointment. This can be used to store any extra information that does not fit into the predefined fields.

modified_atstring date-time

provider_npistring

If provided, Collectly will look up imported providers by NPI instead of external_id. Do not provide both 'external_provider_id' and 'provider_npi'.

service_date_endstring required

service_date_end_localstring date-time

service_date_startstring required

service_date_start_localstring date-time

timezone_localstring

Response