Update an inspection type

put

https://vision-api.truepic.{tld}/v3/inspection-types/{inspectionTypeId}

Path Params

inspectionTypeId

integer

required

1 to 2147483647

Inspection type id

Body Params

Partial update: omitted settings are preserved; supplied teams/custom_fields replace their collections. Configure AI Analysis through its dedicated administrator workflow, not this operation.

custom_fields

array of objects

length between 1 and 100

Complete replacement collection. The first field must be required.

custom_fields

Custom fields replace the complete collection. The first must be required. Selectable fields require custom_field_option_set_id.

custom_field_option_set_id

CustomFieldOptionSetID | string,null

Required for selectable fields; otherwise omitted or null.

entry_method

string

enum

required

The entry method for the custom field

Allowed:

is_required

boolean

required

Defaults to false

When true, the user must supply a value for this custom field in order to create an inspection

label

string

required

length ≥ 1

Display label for the customer input.

customer_unique_id_2

object

deprecated

The deprecated second customer reference field. Retained for compatibility; use custom_fields for new integrations.

customer_unique_id_label

string

deprecated

The label for the first customer reference field. Retained in legacy responses and accepted as a deprecated creation input. Use custom_fields for new integrations.

entry_method

string

enum

deprecated

The entry method for the first customer reference field. Retained for compatibility; use custom_fields for new integrations.

Allowed:

inspection_alert_config_id

The id of the inspection alert configuration that is used by this inspection type. References inspection_alert_configs.id

inspection_ready_criteria_text

string | null

Optional inspection-ready criteria text for this inspection type.

is_address_required

boolean

Controls whether an address is required for the inspection or not

is_list_locked

boolean

When true, the list associated with this inspection type cannot be changed

language

string

enum

The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here.

list_id

The id of the list that is used by this inspection type. References lists.id

max_distance_from_address_threshold

the maximum distance away from the configured inspection address that an inspection can be completed in meters.

message_template_set_id

integer

≥ 1

Message templates used by inspections created with this type.

name

string

length between 1 and 255

Nonempty display name.

outcome_set_id

The id of the outcome set that is used by this inspection type. References outcome_sets.id

teams

array | string,null

Replaces all team assignments when supplied; [] removes all assignments.

use_single_name_field

boolean

When true, there is only one name for the user to fill out rather than a separate first name and last name field

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

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.