OnSiteJobsAppointmentType
Fields
The agent assigned to the appointment.
A list of actions triggered by this appointment, across stages.
A list of assets attached to this request.
The cancellation category for this appointment.
The datetime of the latest appointment cancellation event, if the appointment has been cancelled.
The communication strategy for this appointment.
Appointment job type.
Deprecation
The 'externalJobType' field is deprecated.Please use externalJobTypeMapping instead.
- Marked as deprecated on 2026-03-17.
- Scheduled for removal on or after 2026-04-17.
A brownout is in_progress for 'OnSiteJobsAppointmentType.externalJobType' from July 29, 2026, 4:35 a.m. to Aug. 5, 2026, 5:10 a.m..
Mapping of appointment job type value to its human-friendly label.
The work category for this appointment.
The current status of 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
{
"agent": "GENERIC_AGENT",
"appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
"assets": OnSiteJobsAssetConnectionTypeConnection,
"cancellationCategory": "CANCELLED_BY_CUSTOMER",
"cancellationSubCategory": "room-number-both-truth-him",
"cancelledAt": "2001-07-05T23:01:11.076391+00:00",
"comments": "yes-player-reveal-school-rock",
"commsStrategy": "SEND_ALL",
"createdAt": "1981-04-03T03:30:30.635947+00:00",
"deadlineDate": "2022-03-30",
"endAt": "2003-12-31T03:01:12.669511+00:00",
"externalJobTypeMapping": OnSiteJobsExternalJobTypeMappingType,
"externalReference": "might-visit-Republican-would-reflect",
"id": "87ecbe86-ab39-4034-9eba-8775730b19ec",
"jobDetails": {"key": "value"},
"jobNotes": {"key": "value"},
"krakenWorkCategory": "ACCURACY_TEST",
"preferredStartDate": "1981-03-02",
"request": OnSiteJobsRequestType,
"startAt": "1999-10-10T12:58:18.355329+00:00",
"status": "REQUIRES_TIMESLOT"
}