Skip to main content

Input fields

agentReference : String

The siteworks appointment agent reference code.

appointmentId : ID

The siteworks appointment Kraken unique ID.

cancellationCategory : CancellationCategory

The reason the appointment was cancelled (category). Must be specified along with cancellation_sub_category.

cancellationSubCategory : String

The reason the appointment was cancelled (sub-category). Must be specified along with cancellation_category.

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

{ "agentReference": "star-though-scientist-speak-million", "appointmentId": "85344177", "cancellationCategory": "CANCELLED_BY_CUSTOMER", "cancellationSubCategory": "day-wear-loss-half-never" }