INPUT_OBJECT

CreateAppointmentScheduleInput

link GraphQL Schema definition

  • input CreateAppointmentScheduleInput {
  • clientMutationId: String
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Description applied to appointments booked through this schedule.
  • appointmentDescription: String!
  • # Duration of each booked appointment.
  • appointmentDuration: Float
  • # Location applied to appointments booked through this schedule.
  • appointmentLocation: String!
  • # How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).
  • appointmentLocationType: AppointmentScheduleLocationTypeEnum
  • # Id of the user receiving the booking.
  • appointmentOwnerId: ID!
  • # Subject applied to appointments booked through this schedule.
  • appointmentSubject: String!
  • # When true, booked appointments use the schedule_name as their subject instead of
  • # appointment_subject.
  • appointmentSubjectUsesScheduleName: Boolean!
  • # Id of the appointment type.
  • appointmentTypeId: ID!
  • # IANA timezone (e.g. "Europe/Bratislava") in which availability windows are
  • # defined.
  • availabilityTzid: String
  • # Minutes of buffer reserved after each booked appointment.
  • bufferTimeAfter: Int!
  • # Minutes of buffer reserved before each booked appointment.
  • bufferTimeBefore: Int!
  • # What is shown to the booker after confirming (e.g. default Coevera page or a
  • # custom redirect URL).
  • confirmationPageType: AppointmentScheduleConfirmationPageTypeEnum
  • # Custom URL the booker is redirected to after confirming. Used when
  • # confirmation_page_type selects a custom redirect.
  • confirmationPageUrl: String
  • # Master switch for the schedule. Disabled schedules do not accept new bookings.
  • isEnabled: Boolean!
  • # Minimum notice in hours required before a slot can be booked.
  • minimumNoticeTime: Int!
  • # Admin-only name for the schedule, used in pickers and lists. Not shown to
  • # bookers; use schedule_name for the public-facing name.
  • name: String!
  • # Id of the schedule owner.
  • ownerId: ID!
  • # For rolling planning: how many days ahead the schedule remains bookable.
  • planningDayOffset: Int!
  • # For fixed-range planning: first date bookings are accepted for.
  • planningPeriodFrom: Date
  • # For fixed-range planning: last date bookings are accepted for.
  • planningPeriodTo: Date
  • # How far ahead bookings are accepted (e.g. RollingDays, FixedRange).
  • planningType: AppointmentSchedulePlanningTypeEnum
  • # True when a reminder email is sent to invitees ahead of the booked appointment.
  • reminderEmailEnabled: Boolean!
  • # Time before the appointment when the reminder email is sent. Interpreted using
  • # reminder_email_offset_type.
  • reminderEmailOffset: Int!
  • # Unit of reminder_email_offset (e.g. Minutes, Hours, Days).
  • reminderEmailOffsetType: AppointmentScheduleReminderOffsetTypeEnum
  • # Id of the reply company email.
  • replyCompanyEmailId: ID
  • # Public-facing name of the schedule, shown to bookers on the booking page.
  • scheduleName: String!
  • # Step in minutes between offered start times (e.g. 15 means slots at :00, :15,
  • # :30, :45).
  • timeIncrement: Int!
  • # Schedule type (e.g. one-on-one or round-robin).
  • type: AppointmentScheduleTypeEnum
  • # Public URL slug of the schedule, used to share the booking page.
  • url: String!
  • additionalFieldsData: [AppointmentScheduleAdditionalFieldParams!]!
  • availabilityData: AppointmentScheduleAvailabilityParams!
  • appointmentInviteesData: [AppointmentScheduleInviteeParams!]!
  • }

link Require by