Input fields

alignRequestStatusWithAppointment : Boolean default: True

When true, automatically updates the request status to match its appointments. Defaults to true.
appointmentId : UUID! required

The Kraken ID of the appointment to update.
appointmentOn : Date

The date of a full-day appointment.
assets : [OnSiteJobsAssetInput!]

List of assets associated with the appointment.
bypassTerminalAppointmentStatus : Boolean

When true, allows updating an appointment that is already in a terminal status. Defaults to false.
cancellationCategory : OnSiteJobsAppointmentCancellationCategory

The cancellation category, if applicable.
comments : String

Optional comments about the appointment.
commsStrategy : OnSiteJobsCommsStrategy

The communication strategy to apply to this appointment.
endAt : DateTime

The new end datetime for the appointment. For open-ended appointments, set to None.
jobDetails : OnSiteJobsAppointmentJobDetailsInput

Appointment job details.
jobNotes : JSONString

Optional job notes as a JSON object.
runActionsBasedOnStatus : Boolean default: True

Whether to run the side-effect action based on the new appointment status. Only applicable if a value was provided in the status field. Defaults to true.
startAt : DateTime

The new start datetime for the appointment.
status : OnSiteJobsAppointmentStatus

The new status for the appointment.
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.

Example

{ "alignRequestStatusWithAppointment": true, "appointmentId": "894ecb0d-c667-40a8-9378-7e133d38f38e", "appointmentOn": "2022-12-06", "assets": OnSiteJobsAssetInput, "bypassTerminalAppointmentStatus": true, "cancellationCategory": "CANCELLED_BY_CUSTOMER___COMPLAINT", "comments": "whether-compare-one-message-into", "commsStrategy": "SEND_ALL", "endAt": "2014-12-13T11:18:51.956206+00:00", "jobDetails": OnSiteJobsAppointmentJobDetailsInput, "jobNotes": {"key": "value"}, "runActionsBasedOnStatus": true, "startAt": "2022-12-13T08:01:24.183742+00:00", "status": "REQUIRES_TIMESLOT" }