Skip to main content

Arguments

appointmentBookingDetails : OnSiteJobsAppointmentBookingDetailsInput! required

The appointment booking details.

overrideAppointmentCheckWarnings : Boolean

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

requestId : UUID! required

The ID of the request to book an appointment for.

Returns

StartOnSiteJobsAppointmentBookingSessionForRequest

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

Allowed Viewers

Customer Partner User Third party

Required Permissions

Can create on site jobs appointments

Query Complexity

1

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.

Query

mutation StartOnSiteJobsAppointmentBookingSessionForRequest( $appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!, $overrideAppointmentCheckWarnings: Boolean, $requestId: UUID! ) { startOnSiteJobsAppointmentBookingSessionForRequest( appointmentBookingDetails: $appointmentBookingDetails, overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings, requestId: $requestId ) { appointmentBookingSessionId } }

Variables

{ "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput, "overrideAppointmentCheckWarnings": true, "requestId": "e8371486-49e2-4959-be3a-eb11da80a3bb" }

Response

{ "data": { "startOnSiteJobsAppointmentBookingSessionForRequest": { "appointmentBookingSessionId": "fed6e014-65be-4202-9044-0b2d397f8974" } } }