Update a website form

put

https://vision-api.truepic.{tld}/v3/website-forms/{websiteFormId}

Path Params

websiteFormId

integer

required

1 to 2147483647

The ID of the website form.

Body Params

allowed_origins

array of strings

The domains that the website form is allowed to be embedded on. URLs must include https:// and cannot include a path. An asterisk (*) can be used in place of the subdomain to allow any subdomain.

allowed_origins

inspection_type_ids

array of numbers

The IDs of the inspection types that can be created from the website form.

inspection_type_ids

is_email_required

boolean

Whether the email field is required on the website form. Defaults to false.

is_phone_required

boolean

Whether the phone field is required on the website form. Defaults to false.

name

string

The name of the website form.

should_show_address

boolean

Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to false.

team_id

number

The ID of the team that the website form creates inspections within.

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.