Create an inspection type

post

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

Body Params

Request Body for POST /inspection-types

created_by_member_user_id

number

the id of the user who created this inspection type. References users.id

custom_fields

array of objects

required

An array of custom fields that are used by this inspection type

custom_fields*

inspection_alert_config_id

number

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

required

Controls whether an address is required for the inspection or not

is_list_locked

boolean

required

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

language

string

enum

required

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

list_id

number

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

max_distance_from_address_threshold

number

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

message_template_set_id

number

required

The id of the message template set that is used by this inspection type. References message_template_sets.id

modified_by_member_user_id

number

the id of the user who last modified this inspection type. References users.id

name

string

required

The name of the inspection type

outcome_set_id

number

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

teams

array of objects

The teams that are allowed to use this inspection type. Pass each team as an object containing its id. Passing an empty array removes all team associations.

teams

use_single_name_field

boolean

required

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 body couldn't be parsed.

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

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

404The requested resource couldn't be found.

412A required property or parameter is missing from the request.

500An unexpected error occurred.