Update Inspections
Update Inspection Status
Change an inspection's status by sending a PUT request to the /inspections/{inspectionId} endpoint with the new inspection_status_id value.
External integrators typically only need to move inspections to one of two terminal statuses:
| Current inspection status | New status | inspection_status_id |
|---|---|---|
| Scheduled or Created | Canceled | 6 |
| Started or Ready for Review | Closed | 5 |
If you need to move an inspection from Ready for Review or Canceled back to In Progress, resend the inspection by requesting more data. See Request More for that workflow.
For example, to close an inspection, set inspection_status_id to 5:
PUT /v3/inspections/{inspectionId}
{
"inspection_status_id": 5
}If outcomes are enabled for the inspection type, you can close the inspection and assign an outcome in the same request. Include outcome_id for the selected outcome and outcome_reason for the outcome description:
PUT /v3/inspections/{inspectionId}
{
"inspection_status_id": 5,
"outcome_id": 1124,
"outcome_reason": "Customer did not finish taking pictures"
}For more detail about configuring outcomes, see Outcomes.
Not all transitions are valid — each status has specific statuses it can move to. For the full list of statuses, their IDs, descriptions, and allowed transitions, see Inspection Statuses.
Try it out in the API Reference: Inspections > Updating an existing inspection request.
Updating Customer Information
Update customer information with a PUT request to the /inspections/{inspectionId} endpoint. Common updates include correcting the customer name, phone number, email address, or custom field values.
For example, this request updates the customer's name, phone number, email address, and two custom field values:
PUT /v3/inspections/{inspectionId}
{
"customer_first_name": "Example",
"customer_last_name": "Person",
"customer_phone_country": "US",
"customer_phone_number": "1112223333",
"customer_email_address": "[email protected]",
"custom_field_values": ["abc123", "def123"]
}The custom_field_values array must match the order of the custom fields defined on the inspection type. If a custom field is optional and you do not want to set a value, pass null for that position in the array.
Try it out in the API Reference via Inspections > Updating an existing inspection request.
