Update an inspection type

Path Params
integer
required
1 to 2147483647

The inspection type ID.

Body Params

The request body for PUT /inspection-types/{inspectionTypeId}, a partial update. Omitted settings are preserved, and supplied teams and 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

The complete replacement collection of custom fields. The first field must be required.

custom_fields

A custom field. Custom fields replace the complete collection, and the first must be required. Selectable fields require custom_field_option_set_id.

CustomFieldOptionSetID | string,null

The ID of the custom field option set. It's required for selectable fields, and otherwise omitted or null.

string
enum
required

The entry method for the custom field.

Allowed:
boolean
required
Defaults to false

Whether the user must supply a value for this custom field to create an inspection.

string
required
length ≥ 1

The 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.

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.

string
enum
deprecated

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

Allowed:

The ID of the inspection alert configuration this inspection type uses.

boolean

Whether an address is required for the inspection.

boolean

Whether the list associated with this inspection type can't be changed.

string
enum

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

The ID of the list this inspection type uses.

The maximum distance, in meters, from the configured inspection address that an inspection can be completed within.

integer
≥ 1

The ID of the message template set used by inspections created with this type.

string
length between 1 and 255

The display name. It can't be empty.

The ID of the outcome set this inspection type uses.

array | string,null

The teams to assign. When supplied, it replaces all team assignments, and [] removes them all.

boolean

Whether there is only one name field for the user to fill out, rather than separate first name and last name fields.

Responses

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