Skip to content

updateAppointmentInput

Autogenerated input type of updateAppointment

Fields

deprecated DO NOT USE
cancellation_reason_id · ID · The ID of the cancellation reason to apply to all attendees
cancellation_initiated_by · String · Who initiated the cancellation: client, provider, or organization (maps to CancellationReason.reason_type)
cpt_code_id · ID · Cpt code associated with this appointment
datetime · String · Timestamp in YYYY-MM-DD HH:MM:SS or ISO8601 format, supercedes date, time params.
external_videochat_url · String · When passed in, this video chat URL will be used instead of built-in Video Chat or Zoom
deprecated Use `recurring_appointment` instead
late_cancellation_fee · Int · The late cancellation fee in cents
metadata · JSON · a serialized JSON string of metadata
no_show_fee · Int · The no show fee in cents
other_cancellation_reason · String · Other reason for cancellation to apply to all attendees
pm_status · String · The status of the appointment. Can be one of "Occurred", "No-Show", "Re-Scheduled", "Cancelled." If enabled, "Late Cancellation" and "Checked-In" are also valid.
price · String · The price associated with this appointment
deprecated Use `recurring_appointment` instead
deprecated Use `recurring_appointment` instead
deprecated Use `recurring_appointment` instead
timezone · String · Timezone to use for date and time fields. Overrides the timezone of the current user
units · String · Units to use as a multiplier for appointment price
enforce_availability · Boolean · When true, checks if appointment time slot is available before updating. Does not work with recurring appointments or blockers.
suppress_webhook_notifications · Boolean · When true, suppresses "appointment.updated" webhook notifications from this API call. Does not work with recurring appointments.

Used By

Definition

"""
Autogenerated input type of updateAppointment
"""
input updateAppointmentInput {
"""
DO NOT USE
"""
clientMutationId: String @deprecated(reason: "DO NOT USE")
actual_duration: String
appointment_inclusion_uuid: ID
appointment_location_id: String
appointment_type_id: String
attended_clients: [AttendedClientsInput]
attendee_ids: String
"""
The ID of the cancellation reason to apply to all attendees
"""
cancellation_reason_id: ID
"""
Who initiated the cancellation: client, provider, or organization (maps to CancellationReason.reason_type)
"""
cancellation_initiated_by: String
client_confirmed: Boolean
client_updating: Boolean
confirmed: Boolean
contact_type: String
"""
Cpt code associated with this appointment
"""
cpt_code_id: ID
date: String
"""
Timestamp in YYYY-MM-DD HH:MM:SS or ISO8601 format, supercedes date, time params.
"""
datetime: String
end_date: String
end_time: String
"""
When passed in, this video chat URL will be used instead of built-in Video Chat or Zoom
"""
external_videochat_url: String
id: ID
insurance_billing_enabled: Boolean
is_blocker: Boolean
is_zoom_chat: Boolean
join_all: Boolean @deprecated(reason: "Use `recurring_appointment` instead")
"""
The late cancellation fee in cents
"""
late_cancellation_fee: Int
location: String
max_attendees: String
"""
a serialized JSON string of metadata
"""
metadata: JSON
"""
The no show fee in cents
"""
no_show_fee: Int
notes: String
"""
Other reason for cancellation to apply to all attendees
"""
other_cancellation_reason: String
other_party_id: String
"""
The status of the appointment. Can be one of "Occurred", "No-Show", "Re-Scheduled", "Cancelled." If enabled, "Late Cancellation" and "Checked-In" are also valid.
"""
pm_status: String
"""
The price associated with this appointment
"""
price: String
providers: String
recurring_appointment: RecurringAppointmentInput
repeat: Boolean @deprecated(reason: "Use `recurring_appointment` instead")
repeat_interval: String
@deprecated(reason: "Use `recurring_appointment` instead")
repeat_times: String
@deprecated(reason: "Use `recurring_appointment` instead")
room_id: String
time: String
"""
Timezone to use for date and time fields. Overrides the timezone of the current user
"""
timezone: String
"""
Units to use as a multiplier for appointment price
"""
units: String
updateRecurring: Boolean
user_id: String
"""
When true, checks if appointment time slot is available before updating. Does not work with recurring appointments or blockers.
"""
enforce_availability: Boolean = false
"""
When true, suppresses "appointment.updated" webhook notifications from this API call. Does not work with recurring appointments.
"""
suppress_webhook_notifications: Boolean = false
}