Skip to content
Healthie API Docs

CreateAvailabilityWithAppointmentTypesInput

Autogenerated input type of CreateAvailabilityWithAppointmentTypes

Fields

clientMutationId · String · DO NOT USE
deprecated DO NOT USE
appointment_type_ids · [ID!]! · required · IDs of the appointment types this availability covers. Must contain at least one ID and all IDs must belong to the target provider.
start_datetime · ISO8601DateTime! · required · Start of the availability window (ISO 8601 with offset).
end_datetime · ISO8601DateTime! · required · End of the availability window (ISO 8601 with offset). Must be after start_datetime.
user_id · ID · ID of the provider this availability is for. Defaults to the current user when omitted.
timezone · String · IANA timezone name to persist on the availability record. Defaults to the target provider's timezone.
contact_type_id · Int · Contact type (delivery mode) to scope this availability to. Required when the org has times_by_contact_type enabled and the booking flow filters slots by contact type.
appointment_location_id · ID · Appointment location to scope this availability to. Required when the org has times_by_location enabled and the booking flow filters slots by location.

Used By

Definition 

"""
Autogenerated input type of CreateAvailabilityWithAppointmentTypes
"""
input CreateAvailabilityWithAppointmentTypesInput {
  """
  DO NOT USE
  """
  clientMutationId: String @deprecated(reason: "DO NOT USE")


  """
  IDs of the appointment types this availability covers. Must contain at least one ID and all IDs must belong to the target provider.
  """
  appointment_type_ids: [ID!]!


  """
  Start of the availability window (ISO 8601 with offset).
  """
  start_datetime: ISO8601DateTime!


  """
  End of the availability window (ISO 8601 with offset). Must be after start_datetime.
  """
  end_datetime: ISO8601DateTime!


  """
  ID of the provider this availability is for. Defaults to the current user when omitted.
  """
  user_id: ID


  """
  IANA timezone name to persist on the availability record. Defaults to the target provider's timezone.
  """
  timezone: String


  """
  Contact type (delivery mode) to scope this availability to. Required when the org has times_by_contact_type enabled and the booking flow filters slots by contact type.
  """
  contact_type_id: Int


  """
  Appointment location to scope this availability to. Required when the org has times_by_location enabled and the booking flow filters slots by location.
  """
  appointment_location_id: ID
}