curl --request PATCH \
--url https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"required": true,
"minimum_score": 3,
"level_1_description": "<string>",
"level_2_description": "<string>",
"level_3_description": "<string>",
"level_4_description": "<string>",
"level_5_description": "<string>",
"weight": "<string>"
}
'import requests
url = "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}"
payload = {
"name": "<string>",
"description": "<string>",
"required": True,
"minimum_score": 3,
"level_1_description": "<string>",
"level_2_description": "<string>",
"level_3_description": "<string>",
"level_4_description": "<string>",
"level_5_description": "<string>",
"weight": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
required: true,
minimum_score: 3,
level_1_description: '<string>',
level_2_description: '<string>',
level_3_description: '<string>',
level_4_description: '<string>',
level_5_description: '<string>',
weight: '<string>'
})
};
fetch('https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'required' => true,
'minimum_score' => 3,
'level_1_description' => '<string>',
'level_2_description' => '<string>',
'level_3_description' => '<string>',
'level_4_description' => '<string>',
'level_5_description' => '<string>',
'weight' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"minimum_score\": 3,\n \"level_1_description\": \"<string>\",\n \"level_2_description\": \"<string>\",\n \"level_3_description\": \"<string>\",\n \"level_4_description\": \"<string>\",\n \"level_5_description\": \"<string>\",\n \"weight\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"minimum_score\": 3,\n \"level_1_description\": \"<string>\",\n \"level_2_description\": \"<string>\",\n \"level_3_description\": \"<string>\",\n \"level_4_description\": \"<string>\",\n \"level_5_description\": \"<string>\",\n \"weight\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"minimum_score\": 3,\n \"level_1_description\": \"<string>\",\n \"level_2_description\": \"<string>\",\n \"level_3_description\": \"<string>\",\n \"level_4_description\": \"<string>\",\n \"level_5_description\": \"<string>\",\n \"weight\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"kind": "competency",
"sequence_number": 123,
"is_active": true,
"required": true,
"minimum_score": 3,
"level_1_description": "<string>",
"level_2_description": "<string>",
"level_3_description": "<string>",
"level_4_description": "<string>",
"level_5_description": "<string>",
"weight": "<string>"
}[
{
"code": "error",
"detail": "<string>",
"attr": "<string>"
}
][
{
"code": "error",
"detail": "<string>",
"attr": "<string>"
}
][
{
"code": "error",
"detail": "<string>",
"attr": "<string>"
}
]Update a criterion
GET/PATCH/DELETE a single criterion. DELETE soft-deletes it.
curl --request PATCH \
--url https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"required": true,
"minimum_score": 3,
"level_1_description": "<string>",
"level_2_description": "<string>",
"level_3_description": "<string>",
"level_4_description": "<string>",
"level_5_description": "<string>",
"weight": "<string>"
}
'import requests
url = "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}"
payload = {
"name": "<string>",
"description": "<string>",
"required": True,
"minimum_score": 3,
"level_1_description": "<string>",
"level_2_description": "<string>",
"level_3_description": "<string>",
"level_4_description": "<string>",
"level_5_description": "<string>",
"weight": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
required: true,
minimum_score: 3,
level_1_description: '<string>',
level_2_description: '<string>',
level_3_description: '<string>',
level_4_description: '<string>',
level_5_description: '<string>',
weight: '<string>'
})
};
fetch('https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'required' => true,
'minimum_score' => 3,
'level_1_description' => '<string>',
'level_2_description' => '<string>',
'level_3_description' => '<string>',
'level_4_description' => '<string>',
'level_5_description' => '<string>',
'weight' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"minimum_score\": 3,\n \"level_1_description\": \"<string>\",\n \"level_2_description\": \"<string>\",\n \"level_3_description\": \"<string>\",\n \"level_4_description\": \"<string>\",\n \"level_5_description\": \"<string>\",\n \"weight\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"minimum_score\": 3,\n \"level_1_description\": \"<string>\",\n \"level_2_description\": \"<string>\",\n \"level_3_description\": \"<string>\",\n \"level_4_description\": \"<string>\",\n \"level_5_description\": \"<string>\",\n \"weight\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config/criteria/{criterion_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"minimum_score\": 3,\n \"level_1_description\": \"<string>\",\n \"level_2_description\": \"<string>\",\n \"level_3_description\": \"<string>\",\n \"level_4_description\": \"<string>\",\n \"level_5_description\": \"<string>\",\n \"weight\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"kind": "competency",
"sequence_number": 123,
"is_active": true,
"required": true,
"minimum_score": 3,
"level_1_description": "<string>",
"level_2_description": "<string>",
"level_3_description": "<string>",
"level_4_description": "<string>",
"level_5_description": "<string>",
"weight": "<string>"
}[
{
"code": "error",
"detail": "<string>",
"attr": "<string>"
}
][
{
"code": "error",
"detail": "<string>",
"attr": "<string>"
}
][
{
"code": "error",
"detail": "<string>",
"attr": "<string>"
}
]Authorizations
API key authentication for the public API. Pass your API key as a Bearer token.
Body
Short label shown on the scorecard (e.g. 'Clinical judgment', 'Holds nursing license').
1What this criterion evaluates. Role-specific and observable from the interview. For qualifications, the description must name the specific verifiable bar: the credential, license, work authorization, or numerical threshold the candidate must meet to pass.
1Competency: graded 1-5 against a behaviorally anchored rubric (uses weight). Qualification: pass/fail against the bar stated in description (weight ignored).
competency- Competencyqualification- Qualification
competency, qualification If true, this criterion is a hard requirement. Failing it flags the candidate as ineligible regardless of other scores. For qualifications: failing = the bar in description not met. For competencies: failing = assessed score below minimum_score (if set), or criterion unassessable.
[Competency only] Optional 1-5 threshold for required competencies. Candidate fails the hard requirement if the scored level is below this. Leave null to require the criterion be assessable without a specific floor. Must be null for qualifications.
1 <= x <= 5[Competency only] Level 1 - clear deficit. Would fail in the role. Required for competencies; must be blank for qualifications.
[Competency only] Level 2 - below expectations. Needs significant development. Required for competencies; must be blank for qualifications.
[Competency only] Level 3 - meets expectations. Solid hire for this role. Required for competencies; must be blank for qualifications.
[Competency only] Level 4 - exceeds expectations. Strong hire. Required for competencies; must be blank for qualifications.
[Competency only] Level 5 - exceptional. Stands out clearly. Required for competencies; must be blank for qualifications.
[Competency only] Relative importance of this competency in overall score calculation. Default is 1.0 (normal importance). Use 0.5 for nice-to-have, 1.5 for core skill. 0 means this criterion is not used for scoring.
^-?\d{0,3}(?:\.\d{0,2})?$Response
Short label shown on the scorecard (e.g. 'Clinical judgment', 'Holds nursing license').
What this criterion evaluates. Role-specific and observable from the interview. For qualifications, the description must name the specific verifiable bar: the credential, license, work authorization, or numerical threshold the candidate must meet to pass.
Competency: graded 1-5 against a behaviorally anchored rubric (uses weight). Qualification: pass/fail against the bar stated in description (weight ignored).
competency- Competencyqualification- Qualification
competency, qualification Inactive criteria are not used in interview scoring
If true, this criterion is a hard requirement. Failing it flags the candidate as ineligible regardless of other scores. For qualifications: failing = the bar in description not met. For competencies: failing = assessed score below minimum_score (if set), or criterion unassessable.
[Competency only] Optional 1-5 threshold for required competencies. Candidate fails the hard requirement if the scored level is below this. Leave null to require the criterion be assessable without a specific floor. Must be null for qualifications.
1 <= x <= 5[Competency only] Level 1 - clear deficit. Would fail in the role. Required for competencies; must be blank for qualifications.
[Competency only] Level 2 - below expectations. Needs significant development. Required for competencies; must be blank for qualifications.
[Competency only] Level 3 - meets expectations. Solid hire for this role. Required for competencies; must be blank for qualifications.
[Competency only] Level 4 - exceeds expectations. Strong hire. Required for competencies; must be blank for qualifications.
[Competency only] Level 5 - exceptional. Stands out clearly. Required for competencies; must be blank for qualifications.
[Competency only] Relative importance of this competency in overall score calculation. Default is 1.0 (normal importance). Use 0.5 for nice-to-have, 1.5 for core skill. 0 means this criterion is not used for scoring.
^-?\d{0,3}(?:\.\d{0,2})?$