Skip to main content
PATCH
Partially Update Appointment

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer<int64>
required

Body

application/json
appointment_type_id
integer<int64> | null

The ID of an existing appointment type to assign to the appointment. Provide this instead of 'reason' to reference a specific appointment type rather than matching or creating one by name. If both 'reason' and 'appointment_type_id' are supplied, 'reason' takes precedence.

billing_details
object | null

The billing details for the appointment.

description
string | null
duration
integer

The duration of the appointment in minutes. If duration is not provided, the default duration will be used given a reason.

Required range: -2147483648 <= x <= 2147483647
instructions
string | null
metadata
object | null
mode
enum<string>
Available options:
IN_PERSON,
VIDEO
patient
integer<int64> | null
payment
object | null
physician
integer<int64>
practice
integer<int64>
reason
string | null
Maximum string length: 50
recurring_event_schedule
integer<int64> | null
scheduled_date
string<date-time>
service_location

The ID of the service location where the appointment will occur.

status
object | null
telehealth_details
string | null
deprecated
time_slot_status
enum<string> | null
Available options:
not_avail_for_self_schedule
time_slot_type
enum<string>
Available options:
appointment,
appointment_slot,
event
transportation_details
object | null

The transportation details for the appointment.

Response

200 - application/json
patient
integer<int64> | null
required
physician
integer<int64>
required
practice
integer<int64>
required
scheduled_date
string<date-time>
required
appointment_type_id
integer<int64> | null

The ID of an existing appointment type to assign to the appointment. Provide this instead of 'reason' to reference a specific appointment type rather than matching or creating one by name. If both 'reason' and 'appointment_type_id' are supplied, 'reason' takes precedence.

billing_details
object | null

The billing details for the appointment.

created_date
string<date-time> | null
read-only
deleted_date
string<date-time> | null
read-only
description
string | null
duration
integer

The duration of the appointment in minutes. If duration is not provided, the default duration will be used given a reason.

Required range: -2147483648 <= x <= 2147483647
id
integer
read-only
instructions
string | null
is_blocking
boolean
read-only
last_modified_date
string<date-time>
read-only
metadata
object | null
mode
enum<string>
Available options:
IN_PERSON,
VIDEO
payment
object | null
reason
string | null
Maximum string length: 50
recurring_event_schedule
integer<int64> | null
service_location

The ID of the service location where the appointment will occur.

status
object | null
telehealth_details
string | null
deprecated
time_slot_status
enum<string> | null
Available options:
not_avail_for_self_schedule
time_slot_type
enum<string>
Available options:
appointment,
appointment_slot,
event
transportation_details
object | null

The transportation details for the appointment.