API Reference

Create Appointment

post
https://unify.kolla.dev/dental/v1/appointments

Creates a new appointment for an existing patient.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

An Appointment represents a scheduled visit for a patient at a dental practice in the Unify Dental API.

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.

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.

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.

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.

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.

string

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

string

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

string
length ≤ 100

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

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

Updated 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago