Update Appointment

patch

https://unify.kolla.dev/dental/v1/appointments/{appointment}

Updates an existing appointment. Only fields specified in the update mask are modified.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appointment

string

required

The appointment id.

Query Params

update_mask

string

Optional. Only the fields specified in the mask will be updated. If omitted, all fields included in the request body are updated.

Body Params

contact_id

string

Resource name of the patient contact associated with this appointment, in the format contacts/{contact}.

contact

object

Lightweight representation of a patient contact, embedded for convenient display without a separate lookup.

start_time

date-time

Start time of the appointment in RFC 3339 format (UTC). Use time_zone to convert to local time. On creation, provide either start_time with time_zone, or wall_start_time.

end_time

date-time

End time of the appointment in RFC 3339 format (UTC). Use time_zone to convert to local time. On creation, provide either end_time with time_zone, or wall_end_time.

wall_start_time

string

Start time in the location's local time zone, formatted as yyyy-mm-dd hh:mm:ss. On creation, provide either this field or start_time with time_zone.

wall_end_time

string

End time in the location's local time zone, formatted as yyyy-mm-dd hh:mm:ss. On creation, provide either this field or end_time with time_zone.

providers

array of objects

Dental providers (e.g., dentists, hygienists) assigned to perform this appointment.

providers

scheduler

object

Lightweight representation of a practice resource (provider, room, or equipment), embedded for convenient reference without a separate lookup.

appointment_type_id

string

Resource name of the appointment type, in the format appointmenttypes/{appointment_type}.

operatory

string

Resource name of the operatory (treatment room) where the appointment takes place, in the format resources/{resource}.

short_description

string

length ≤ 100

Brief description of the appointment, typically set by the integration or practice. Limited to 100 characters.

notes

string

length ≤ 1000

Free-text notes for the appointment. May be truncated to 1000 characters by the source system.

additional_data

object

Source-system-specific key-value data for the appointment that does not map to a standard field.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response