Skip to content

Update Qualification Template

PUT
/enrichment/ai/qualification/templates/{template_id}

Edit a qualification template. Free to edit.

ADMIN ONLY, matching the app - a template decides how every record in the organisation is scored, so it is not ordinary list configuration.

The prompt has a 100-character MINIMUM. That is the app’s, and it is a quality floor rather than an accident: a two-word qualification prompt scores everything the same way and bills for it.

Authorizations

Parameters

Path Parameters

template_id
required

Qualification template id (UUID).

string

Qualification template id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Edit a qualification template’s wording.

object
description
required
string
<= 500 characters
name
required
string
>= 1 characters <= 120 characters
prompt
required
string
>= 100 characters <= 30000 characters

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string