Skip to content
Healthie API Docs

editAvailabilityInput

Autogenerated input type of editAvailability

Fields

clientMutationId · String · DO NOT USE
deprecated DO NOT USE
appointment_types · AppointmentTypeSelectionInput · Replaces the appointment types this availability covers (provide exactly one option). A recurring series with past occurrences is split; the new set applies going forward. Omit for the legacy appointment_type_id behavior.
contact_types · ContactTypeSelectionInput · Replaces the contact types this availability can be scheduled with. A recurring series with past occurrences is split; the new set applies going forward. Omit to keep the current contact types.
start_datetime · ISO8601DateTime · New window start (ISO 8601 with offset); omit to keep the current value. Ignored without appointment_types, contact_types, or days_of_week.
end_datetime · ISO8601DateTime · New window end (ISO 8601 with offset); must be after start_datetime. Omit to keep the current value. Ignored without appointment_types, contact_types, or days_of_week.
split_date · ISO8601Date · The occurrence a recurring series split starts on, in the edit's timezone. A date off the series' current and new days moves to the next one. When the edit splits the series, earlier occurrences keep their settings. Omit to split on the next occurrence on or after today. If the new days have no date before the series ends, the series just ends there and the original availability is returned. Ignored without appointment_types, contact_types, or days_of_week.

Used By

Definition 

"""
Autogenerated input type of editAvailability
"""
input editAvailabilityInput {
  """
  DO NOT USE
  """
  clientMutationId: String @deprecated(reason: "DO NOT USE")
  appointment_location_id: ID
  appointment_type_id: ID
  contact_type_id: ID


  "Replaces the appointment types this availability covers (provide exactly one option).\nA recurring series with past occurrences is split; the new set applies going forward.\nOmit for the legacy appointment_type_id behavior.\n"
  appointment_types: AppointmentTypeSelectionInput


  "Replaces the contact types this availability can be scheduled with.\nA recurring series with past occurrences is split; the new set applies going forward.\nOmit to keep the current contact types.\n"
  contact_types: ContactTypeSelectionInput


  "New window start (ISO 8601 with offset); omit to keep the current value.\nIgnored without appointment_types, contact_types, or days_of_week.\n"
  start_datetime: ISO8601DateTime


  "New window end (ISO 8601 with offset); must be after start_datetime. Omit to keep the current value.\nIgnored without appointment_types, contact_types, or days_of_week.\n"
  end_datetime: ISO8601DateTime


  "The occurrence a recurring series split starts on, in the edit's timezone. A date off the\nseries' current and new days moves to the next one. When the edit splits the series,\nearlier occurrences keep their settings. Omit to split on the next occurrence on or after today.\nIf the new days have no date before the series ends, the series just ends there and the\noriginal availability is returned. Ignored without appointment_types, contact_types, or days_of_week.\n"
  split_date: ISO8601Date
  day_of_week: Int
  end_on: String
  end_time: String
  id: String
  is_repeating: Boolean
  range_end: String
  range_start: String
  time: String
  timezone: String
  user_id: ID
}