Create an inspection

post

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

Query Params

include

array of strings

The top-level result fields to include in the response.

If not set, all fields are included by default. If set, id, created_at, and updated_at are always included as a baseline.

include

Body Params

Create an inspection for team_id. Select inspection_type_id when the team has multiple types. Supply customer_name alone, or customer_first_name and customer_last_name. Custom-field values correspond to the selected type's ordered fields; required fields must have values. Address requirements depend on the type. Scheduling requires both scheduled_for and scheduled_tz; the date must be in the future and the timezone must be a valid IANA name.

assigned_to_member_user

string

The user to assign the inspection to. Can be either a user ID or an email address.

copied_customer_info_was_edited

boolean

Whether the customer info was edited relative to the copied inspection.

copied_from_inspection_id

number

The ID of the inspection this one was copied from, if applicable.

copied_list_was_edited

boolean

Whether the list was edited relative to the copied inspection.

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

The address where the inspection will be performed.

customer_address_lat

string

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

customer_address_lng

string

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

This must be set to true when including items in the list object.

inspection_ready_criteria_text

string | null

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

inspection_type_id

number

The id of the inspection type this inspection is for.

list

object

Populate this object with list items to prompt the user for specific photos, videos, or questions during the inspection.

message_supplement

string

length ≤ 255

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

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.

team_id

number

required

The id of the team this inspection is for.

Responses

200Request 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.