Update an inspection

put

https://vision-api.truepic.{tld}/v3/inspections/{inspectionId}

Path Params

inspectionId

integer

required

The ID of the existing inspection request.

Body Params

Partial update: omitted scalar fields are preserved. Supplied custom_field_values replace 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.

assigned_to_member_user_id

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 the value is optional then you can provide null for that value.

custom_field_values

customer_address

string | null

The address where the inspection will be performed.

customer_address_lat

string | null

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

customer_address_lng

string | null

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

customer_email_address

string

length ≤ 255

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

customer_first_name

string

length ≤ 255

The first name of the customer completing the inspection.

customer_last_name

string

length ≤ 255

The last name of the customer completing the inspection.

customer_name

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.

customer_phone_country

string

length ≤ 2

The country code for the customer's phone number.

customer_phone_number

string

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

include_list

boolean

Defaults to false

Must be true when including list.

inspection_ready_criteria_text

string | null

Free-form inspection-ready criteria text. Max length 10KB.

inspection_status_id

number

enum

The id of the inspection status this inspection is in.

list

object

Optionally include list updates with items. When provided with include_list: true, the list will be created or updated for the inspection (if scheduled).

message_supplement

string

length ≤ 255

The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.

outcome_id

number

The id of the outcome of this inspection.

outcome_reason

string

The reason for the outcome of this inspection

scheduled_for

date-time

The date/time (in UTC) the inspection is scheduled to be sent to the customer

scheduled_tz

string

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

send_methods

object

The method(s) to send the inspection request to the customer completing the inspection.

Responses

200The request was successful.

400The request is malformed or fails path, query, body, or lifecycle validation. Standard errors include response_code, message and api_version. Use the x-request-id response header when reporting a failed request.

401Authentication failed, or the user/client doesn't have permission to access the requested resource.

403The user doesn't have permission to access the requested resource.

404The requested resource couldn't be found.

412A request precondition failed. Some operations also return 412 when a related resource is not found, such as an assigned member when updating an inspection. Missing required fields normally return 400. Check the operation and message for the failed precondition.

500An unexpected error occurred.