Skip to navigation
API ReferenceWork Orders

Update Work Order

Update information for a specific work order

Authentication

x-api-keystring
API Key authentication via header

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.
priorityenumRequired
Allowed values:
maintenanceLocationTypeenumRequired

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

Allowed values:
updatedBystringRequiredformat: "uuid"
customerIdstringOptionalformat: "uuid"
ID from the Customer table. Required if maintenanceLocationType is UNIT.
descriptionstringOptional<=500 characters
hourlyServiceRatedoubleOptional
The hourly service rate.
entryPreferenceenumOptional
Allowed values:
entryNotesstringOptional<=500 characters
hasPetAlertbooleanOptional
Indicates if there are pets at the location.
householdIdstringOptionalformat: "uuid"
Required if maintenanceLocationType is UNIT.
otherLocationDetailsstringOptional<=100 characters
requestorEmailstring or nullOptionalformat: "email"<=100 characters

Email address of the person who requested the work. Optional. An empty or blank value is treated as no value. On update, sending an explicit null clears a previously stored value, while omitting the field leaves it unchanged. When a non-blank value is sent it must be a valid email address of at most 100 characters.

requestorNamestringOptional<=100 characters
requestorPhonestring or nullOptional<=15 characters

Phone number of the person who requested the work. Optional. An empty or blank value is treated as no value. On update, sending an explicit null clears a previously stored value, while omitting the field leaves it unchanged. When a non-blank value is sent it must be at most 15 characters.

requestedStartDateFromdateOptional
requestedStartDateTodateOptional
requestedStartTimeFromstringOptional

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

requestedStartTimeTostringOptional

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

totalCostOfMaterialsUseddoubleOptional
The total cost of materials used.
totalAmountOwedByResidentdoubleOptional
The total amount owed by the resident.
unitIdstringOptionalformat: "uuid"
Required if maintenanceLocationType is UNIT.
technicianNotesstringOptional
Notes to the technician.
previouslyReportedbooleanOptional
If the Issue was previously reported, this will be true.
serviceNotesstringOptional<=500 characters
vendorNotesstringOptional<=500 characters
holdReasonstringOptional
readableIdstringOptional
dueDatedateOptional
The due date for the work order.
isDoorCodeActivebooleanOptional
Indicates if the door code is active.
isAlarmActivebooleanOptional
Indicates if the alarm is active.
doorCodestringOptional
The door code for the location.
alarmCodestringOptional
The alarm code for the location.

Response

Expected response to a valid request
statusenumOptional
Allowed values:
priorityenumOptional
Allowed values:
hasPetAlertbooleanOptional
completedAtdatetimeOptional
requestorPhonestring or nullOptional
requestorEmailstring or nullOptionalformat: "emailAddress"
requestedStartDateFromdateOptional
requestedStartDateTodateOptional
requestedStartTimeFromstringOptional
requestedStartTimeTostringOptional
dueDatedateOptional
descriptionstringOptional<=500 characters
serviceNotesstringOptional<=2000 characters
vendorNotesstringOptional<=2000 characters
entryNotesstringOptional<=500 characters
entryPreferenceenumOptional
Allowed values:
isDoorCodeActivebooleanOptional
isAlarmActivebooleanOptional
doorCodestringOptional
alarmCodestringOptional
holdReasonstringOptional
otherLocationDetailstringOptional<=500 characters
attachmentIdsstringOptionalformat: "uuid"
technicianNotesstringOptional<=500 characters
Notes to the technician.
previouslyReportedbooleanOptional
If the Issue was previously reported, this will be true.
idstringOptionalformat: "uuid"
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtstringOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
assignedUserIdstringOptionalformat: "uuid"
householdIdstringOptionalformat: "uuid"
customerIdstringOptionalformat: "uuid"
unitIdstringOptionalformat: "uuid"
maintenanceIssueIdstringOptionalformat: "uuid"
maintenanceLocationIdstringOptionalformat: "uuid"
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
totalCostOfMaterialsUseddoubleOptional
The total cost of materials used.
totalAmountOwedByResidentdoubleOptional
The total amount owed by the resident.
totalAmountOwedByPropertydoubleOptional
The total amount owed by the property.
hourlyServiceRatedoubleOptional
The hourly service rate.
totalLaborCostdoubleOptional
The total labor cost.