Update team

put

https://vision-api.truepic.{tld}/v3/organization-teams/{teamId}

Path Params

teamId

number

required

The ID of the team to upload these assets for

Body Params

The request body for the PUT /organization-teams/{teamId} endpoint

allow_image_deletes

boolean

Defaults to true

Whether to allow app users to delete images during an inspection.

allow_list_item_capture_max

boolean

Defaults to false

Whether app users should have a maximum limit of captures per list item.

app_success_message

The message displayed to the customer on completion of the inspection.

auto_finish_reminder_duration

The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. null means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid. Multiple reminders can be specified by separating them with a comma.

auto_reminder_duration

The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. null means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid. Multiple durations can be specified by separating them with a comma.

color_primary

The primary hex color code used for branding in the app.

customer_app_label

string

The company name to display in the app.

customer_item_label

The word for an "item" in the context of the team.

customer_support_number

The phone number attached to text messages for app users to contact for customer support.

distance_from_customer_address_threshold

The distance (in meters) from the customer's address a photo/video can be taken before being flagged. null can be set to disable the flag.

jwt_customer_expiry

string

Defaults to 480h

The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.

name

string

The name of the team.

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.