cancelSiteworksAppointment
Cancel a Siteworks appointment. Can be called by account users and organisations.
Deprecation
The 'cancelSiteworksAppointment' field is deprecated.Please use cancelOnSiteJobsAppointment instead.
- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.
Arguments
Input fields for cancelling a siteworks appointment.
Returns
CancelSiteworksAppointmentCancel a Siteworks appointment. Can be called by account users and organisations.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-13018: Unable to record cancellation_category/cancellation_sub_category.
- KT-CT-13019: Vendor not found.
- KT-CT-13043: Cannot update appointment as it has terminal status.
- KT-CT-13046: Unable to record cancellation_sub_category.
- KT-CT-13053: Failed to cancel the appointment with the agent.
- KT-CT-13065: Cancellation sub-category is deprecated and can no longer be used.
- KT-CT-7899: An internal error occurred.
- KT-GB-4216: Error cancelling siteworks appointment.
- KT-GB-4218: Appointment cancellation not yet supported.
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can cancel siteworks appointmentsQuery Complexity
1Examples
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 CancelSiteworksAppointment($input: CancelSiteworksAppointmentInput!) {
cancelSiteworksAppointment(input: $input) {
siteworksAppointment {
...ActiveAppointmentTypeFragment
}
}
}
Variables
{
"input": CancelSiteworksAppointmentInput
}
Response
{
"data": {
"cancelSiteworksAppointment": {
"siteworksAppointment": ActiveAppointmentType
}
}
}