startOnSiteJobsAppointmentBookingSessionForDraftAppointment

Start the appointment booking process for an on-site jobs draft appointment.

Arguments

draftAppointmentId : UUID!


            required

The ID of the draft appointment to book.

overrideAppointmentCheckWarnings : Boolean

Whether to override appointment booking check warnings. Defaults to False.

Returns

StartOnSiteJobsAppointmentBookingSessionForDraftAppointment

Output type of the startOnSiteJobsAppointmentBookingSessionForDraftAppointment mutation.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can create on site jobs appointments

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

mutation StartOnSiteJobsAppointmentBookingSessionForDraftAppointment(
  $draftAppointmentId: UUID!,
  $overrideAppointmentCheckWarnings: Boolean
) {
  startOnSiteJobsAppointmentBookingSessionForDraftAppointment(
    draftAppointmentId: $draftAppointmentId,
    overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings
  ) {
    appointmentBookingSessionId
  }
}

{
  "draftAppointmentId": "1c6f10ba-dea9-4a02-ac49-61de3f235de1",
  "overrideAppointmentCheckWarnings": true
}

{
  "data": {
    "startOnSiteJobsAppointmentBookingSessionForDraftAppointment": {
      "appointmentBookingSessionId": "a2ee7365-31d6-47dd-87b6-57df316cd842"
    }
  }
}