Update an inspection

Path Params
integer
required

The ID of the existing inspection request.

Body Params

The request body for PUT /inspections/{inspectionId}, a partial update. Omitted scalar fields are preserved, and a supplied custom_field_values replaces the array. Address and customer field requirements still follow the selected inspection type. Rescheduling requires both scheduled_for and scheduled_tz, and is limited to scheduled inspections.

number

The ID of the user this inspection is assigned to.

custom_field_values
array of strings

The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type. If a value is optional, you can provide null for it.

custom_field_values
string | null

The address where the inspection will be performed.

string | null

The latitude of the address where the inspection will be performed.

string | null

The longitude of the address where the inspection will be performed.

string
length ≤ 255

The email address of the customer completing the inspection. Required if send_methods.email is true.

string
length ≤ 255

The first name of the customer completing the inspection.

string
length ≤ 255

The last name of the customer completing the inspection.

string
length ≤ 255

The full name of the customer who will be completing the inspection. If specified, then customer_first_name and customer_last_name will not be provided.

string
length ≤ 2

The country code for the customer's phone number.

string

The mobile number of the customer completing the inspection. Required if send_methods.text is true.

boolean
Defaults to false

Whether the request includes list. It must be true when including list.

number
enum

The ID of the inspection status this inspection is in.

list
object

Optional list updates with items. When provided with include_list: true, the list is created or updated for the inspection, if it's scheduled.

string
length ≤ 255

The message supplement (custom note) to attach to the request text or email. At most 255 characters.

number

The ID of the outcome of this inspection.

string

The reason for the outcome of this inspection.

date-time

When the inspection is scheduled to be sent to the customer, in UTC.

string

The IANA time zone name for the inspection's scheduled time. Used only for display purposes, as scheduled_for is in UTC.

send_methods
object

The methods used to send the inspection request to the customer completing the inspection.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json