Skip to content

EditAvailabilityWithAppointmentTypesInput

Autogenerated input type of EditAvailabilityWithAppointmentTypes

Fields

id · ID! · required · ID of the availability to edit.
appointment_type_ids · [ID!] · Up to 200 appointment type IDs accessible to the user. Use link_all_non_group_types if associating all IDs.
link_all_non_group_types · Boolean · When true, the availability covers every non-group appointment type the provider owns. Mutually exclusive with appointment_type_ids.
start_datetime · ISO8601DateTime · Updated start of the availability window (ISO 8601 with offset). When omitted the existing value is kept.
end_datetime · ISO8601DateTime · Updated end of the availability window (ISO 8601 with offset). When omitted the existing value is kept. Must be after start_datetime.
timezone · String · IANA timezone name to persist on the availability record. When omitted the existing value is kept.
contact_type_id · Int · Contact type (delivery mode) to scope this availability to. When omitted the existing value is kept.
appointment_location_id · ID · Appointment location to scope this availability to. When omitted the existing value is kept.
is_repeating · Boolean · Set true for a weekly recurring availability or false for a one-time one. When omitted the existing recurrence is kept. Switching to recurring requires day_of_week; switching to one-time clears day_of_week and end_on.
day_of_week · Int · Day of week the recurrence falls on (0 = Sunday through 6 = Saturday). Used when the availability is recurring.
end_on · ISO8601Date · Optional last date the recurrence is active. Used when the availability is recurring.

Used By

Definition

"""
Autogenerated input type of EditAvailabilityWithAppointmentTypes
"""
input EditAvailabilityWithAppointmentTypesInput {
"""
ID of the availability to edit.
"""
id: ID!
"""
Up to 200 appointment type IDs accessible to the user. Use link_all_non_group_types if associating all IDs.
"""
appointment_type_ids: [ID!]
"""
When true, the availability covers every non-group appointment type the provider owns. Mutually exclusive with appointment_type_ids.
"""
link_all_non_group_types: Boolean
"""
Updated start of the availability window (ISO 8601 with offset). When omitted the existing value is kept.
"""
start_datetime: ISO8601DateTime
"""
Updated end of the availability window (ISO 8601 with offset). When omitted the existing value is kept. Must be after start_datetime.
"""
end_datetime: ISO8601DateTime
"""
IANA timezone name to persist on the availability record. When omitted the existing value is kept.
"""
timezone: String
"""
Contact type (delivery mode) to scope this availability to. When omitted the existing value is kept.
"""
contact_type_id: Int
"""
Appointment location to scope this availability to. When omitted the existing value is kept.
"""
appointment_location_id: ID
"""
Set true for a weekly recurring availability or false for a one-time one. When omitted the existing recurrence is kept. Switching to recurring requires day_of_week; switching to one-time clears day_of_week and end_on.
"""
is_repeating: Boolean
"""
Day of week the recurrence falls on (0 = Sunday through 6 = Saturday). Used when the availability is recurring.
"""
day_of_week: Int
"""
Optional last date the recurrence is active. Used when the availability is recurring.
"""
end_on: ISO8601Date
}