API ReferenceWork Orders

Update Work Order

Update information for a specific work order

Path parameters

workOrderIdstringRequired
The id of the work order

Request

This endpoint expects an object.
maintenanceIssueIdstringRequiredformat: "uuid"
ID from the maintenance issue api response.
maintenanceLocationIdstringRequiredformat: "uuid"
ID from the maintenance location api response.
maintenanceLocationTypeenumRequired

Indicates the type of location. Used to conditionally require certain fields (e.g., unitId, householdId).

Allowed values:
priorityenumRequired
Allowed values:
updatedBystringRequiredformat: "uuid"
alarmCodestringOptional
The alarm code for the location.
customerIdstringOptionalformat: "uuid"
ID from the Customer table. Required if maintenanceLocationType is UNIT.
descriptionstringOptional<=500 characters
doorCodestringOptional
The door code for the location.
dueDatestringOptionalformat: "date"
The due date for the work order.
entryNotesstringOptional<=500 characters
entryPreferenceenumOptional
Allowed values:
hasPetAlertbooleanOptional
Indicates if there are pets at the location.
holdReasonstringOptional
hourlyServiceRatedoubleOptional
The hourly service rate.
householdIdstringOptionalformat: "uuid"
Required if maintenanceLocationType is UNIT.
isAlarmActivebooleanOptional
Indicates if the alarm is active.
isDoorCodeActivebooleanOptional
Indicates if the door code is active.
otherLocationDetailsstringOptional<=100 characters
previouslyReportedbooleanOptional
If the Issue was previously reported, this will be true.
readableIdstringOptional
requestedStartDateFromstringOptionalformat: "date"
requestedStartDateTostringOptionalformat: "date"
requestedStartTimeFromstringOptional

Time format string (HH:mm:ss or similar)

requestedStartTimeTostringOptional

Time format string (HH:mm:ss or similar)

requestorEmailstringOptionalformat: "email"<=100 characters
requestorNamestringOptional<=100 characters
requestorPhonestringOptional<=15 characters
serviceNotesstringOptional<=500 characters
technicianNotesstringOptional
Notes to the technician.
totalAmountOwedByResidentdoubleOptional
The total amount owed by the resident.
totalCostOfMaterialsUseddoubleOptional
The total cost of materials used.
unitIdstringOptionalformat: "uuid"
Required if maintenanceLocationType is UNIT.
vendorNotesstringOptional<=500 characters

Response

Expected response to a valid request
statusenum or null
Allowed values:
priorityenum or null
Allowed values:
hasPetAlertboolean or null
completedAtdatetime or null
requestorPhonestring or null
requestorEmailstring or null
requestedStartDateFromstring or nullformat: "date"
requestedStartDateTostring or nullformat: "date"
requestedStartTimeFromstring or null
requestedStartTimeTostring or null
dueDatestring or nullformat: "date"
descriptionstring or null<=500 characters
serviceNotesstring or null<=2000 characters
vendorNotesstring or null<=2000 characters
entryNotesstring or null<=500 characters
entryPreferenceenum or null
Allowed values:
isDoorCodeActiveboolean or null
isAlarmActiveboolean or null
doorCodestring or null
alarmCodestring or null
holdReasonstring or null
otherLocationDetailstring or null<=500 characters
attachmentIdsstring or nullformat: "uuid"
technicianNotesstring or null<=500 characters
Notes to the technician.
previouslyReportedboolean or null
If the Issue was previously reported, this will be true.
idstring or nullformat: "uuid"
readableIdstring or null
idempotencyIdstring or nullformat: "uuid"
createdAtstring or null
updatedAtdatetime or null
deletedAtdatetime or null
assignedUserIdstring or nullformat: "uuid"
householdIdstring or nullformat: "uuid"
customerIdstring or nullformat: "uuid"
unitIdstring or nullformat: "uuid"
maintenanceIssueIdstring or nullformat: "uuid"
maintenanceLocationIdstring or nullformat: "uuid"
propertyIdstring or nullformat: "uuid"
organizationIdstring or nullformat: "uuid"
totalCostOfMaterialsUseddouble or null
The total cost of materials used.
totalAmountOwedByResidentdouble or null
The total amount owed by the resident.
totalAmountOwedByPropertydouble or null
The total amount owed by the property.
hourlyServiceRatedouble or null
The hourly service rate.
totalLaborCostdouble or null
The total labor cost.