pcall POST "/api/v1/partner/enrichments" '{ "external_id": "enr-chennai-warehouse", "name": "Warehouse talent pool - Chennai", "schedule": { "language": "english", "start_time": "10:00", "end_time": "18:00", "days": [ "mon", "tue", "wed", "thu", "fri", "sat" ], "timezone": "Asia/Kolkata", "max_retries": 3, "retry_after_hours": 4 }, "questions": [ { "question_text": "Are you open to a new job right now?", "type": "yes_no", "preferred_answer": "yes", "required": true }, { "question_text": "Tell us about the work you do and where you want to work.", "type": "voice", "required": true } ]}'
const res = await call("POST", "/api/v1/partner/enrichments", {
"external_id": "enr-chennai-warehouse",
"name": "Warehouse talent pool - Chennai",
"schedule": {
"language": "english",
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 4
},
"questions": [
{
"question_text": "Are you open to a new job right now?",
"type": "yes_no",
"preferred_answer": "yes",
"required": true
},
{
"question_text": "Tell us about the work you do and where you want to work.",
"type": "voice",
"required": true
}
]
});
const { data } = await res.json();
res = call("POST", "/api/v1/partner/enrichments", {
"external_id": "enr-chennai-warehouse",
"name": "Warehouse talent pool - Chennai",
"schedule": {
"language": "english",
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 4
},
"questions": [
{
"question_text": "Are you open to a new job right now?",
"type": "yes_no",
"preferred_answer": "yes",
"required": True
},
{
"question_text": "Tell us about the work you do and where you want to work.",
"type": "voice",
"required": True
}
]
})
data = res.json()["data"]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => 'enr-chennai-warehouse',
'name' => 'Warehouse talent pool - Chennai',
'schedule' => [
'language' => 'english',
'start_time' => '10:00',
'end_time' => '18:00',
'days' => [
'mon',
'tue',
'wed',
'thu',
'fri',
'sat'
],
'timezone' => 'Asia/Kolkata',
'max_retries' => 3,
'retry_after_hours' => 4
],
'questions' => [
[
'question_text' => 'Are you open to a new job right now?',
'type' => 'yes_no',
'preferred_answer' => 'yes',
'required' => true
],
[
'question_text' => 'Tell us about the work you do and where you want to work.',
'type' => 'voice',
'required' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$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-bc.userecord.io/api/v1/partner/enrichments"
payload := strings.NewReader("{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
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.post("https://api-bc.userecord.io/api/v1/partner/enrichments")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/enrichments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body
{ "success": true, "data": { "enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML", "external_id": "enr-chennai-warehouse", "name": "Warehouse talent pool - Chennai", "description": "", "status": "active", "questions_status": "pending", "delivery": { "whatsapp": true, "voice_call": true, "sms": true }, "schedule": { "language": "english", "start_time": "10:00", "end_time": "18:00", "days": [ "mon", "tue", "wed", "thu", "fri", "sat" ], "timezone": "Asia/Kolkata", "max_retries": 3, "retry_after_hours": 4 }, "question_count": 2, "counts": { "campaigns": 0, "candidates": 0, "sent": 0, "completed": 0 }, "is_external": true, "created_at": "2026-11-10T10:15:30.000Z", "updated_at": "2026-11-10T10:15:30.000Z", "questions": [ { "question_id": "eqq_cc9800817588972e", "order": 0, "question_text": "Are you open to a new job right now?", "short_form": "Open to work", "type": "yes_no", "preferred_answer": "yes", "required": true }, { "question_id": "eqq_7a31f0c2d95b84e6", "order": 1, "question_text": "Tell us about the work you do and where you want to work.", "short_form": "Work and location", "type": "voice", "preferred_answer": null, "required": true } ] }}
Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns enrichment_id. Record prepares translations and voice in the background: read the enrichment until questions_status is ready.
pcall POST "/api/v1/partner/enrichments" '{ "external_id": "enr-chennai-warehouse", "name": "Warehouse talent pool - Chennai", "schedule": { "language": "english", "start_time": "10:00", "end_time": "18:00", "days": [ "mon", "tue", "wed", "thu", "fri", "sat" ], "timezone": "Asia/Kolkata", "max_retries": 3, "retry_after_hours": 4 }, "questions": [ { "question_text": "Are you open to a new job right now?", "type": "yes_no", "preferred_answer": "yes", "required": true }, { "question_text": "Tell us about the work you do and where you want to work.", "type": "voice", "required": true } ]}'
const res = await call("POST", "/api/v1/partner/enrichments", {
"external_id": "enr-chennai-warehouse",
"name": "Warehouse talent pool - Chennai",
"schedule": {
"language": "english",
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 4
},
"questions": [
{
"question_text": "Are you open to a new job right now?",
"type": "yes_no",
"preferred_answer": "yes",
"required": true
},
{
"question_text": "Tell us about the work you do and where you want to work.",
"type": "voice",
"required": true
}
]
});
const { data } = await res.json();
res = call("POST", "/api/v1/partner/enrichments", {
"external_id": "enr-chennai-warehouse",
"name": "Warehouse talent pool - Chennai",
"schedule": {
"language": "english",
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 4
},
"questions": [
{
"question_text": "Are you open to a new job right now?",
"type": "yes_no",
"preferred_answer": "yes",
"required": True
},
{
"question_text": "Tell us about the work you do and where you want to work.",
"type": "voice",
"required": True
}
]
})
data = res.json()["data"]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => 'enr-chennai-warehouse',
'name' => 'Warehouse talent pool - Chennai',
'schedule' => [
'language' => 'english',
'start_time' => '10:00',
'end_time' => '18:00',
'days' => [
'mon',
'tue',
'wed',
'thu',
'fri',
'sat'
],
'timezone' => 'Asia/Kolkata',
'max_retries' => 3,
'retry_after_hours' => 4
],
'questions' => [
[
'question_text' => 'Are you open to a new job right now?',
'type' => 'yes_no',
'preferred_answer' => 'yes',
'required' => true
],
[
'question_text' => 'Tell us about the work you do and where you want to work.',
'type' => 'voice',
'required' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$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-bc.userecord.io/api/v1/partner/enrichments"
payload := strings.NewReader("{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
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.post("https://api-bc.userecord.io/api/v1/partner/enrichments")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/enrichments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body
{ "success": true, "data": { "enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML", "external_id": "enr-chennai-warehouse", "name": "Warehouse talent pool - Chennai", "description": "", "status": "active", "questions_status": "pending", "delivery": { "whatsapp": true, "voice_call": true, "sms": true }, "schedule": { "language": "english", "start_time": "10:00", "end_time": "18:00", "days": [ "mon", "tue", "wed", "thu", "fri", "sat" ], "timezone": "Asia/Kolkata", "max_retries": 3, "retry_after_hours": 4 }, "question_count": 2, "counts": { "campaigns": 0, "candidates": 0, "sent": 0, "completed": 0 }, "is_external": true, "created_at": "2026-11-10T10:15:30.000Z", "updated_at": "2026-11-10T10:15:30.000Z", "questions": [ { "question_id": "eqq_cc9800817588972e", "order": 0, "question_text": "Are you open to a new job right now?", "short_form": "Open to work", "type": "yes_no", "preferred_answer": "yes", "required": true }, { "question_id": "eqq_7a31f0c2d95b84e6", "order": 1, "question_text": "Tell us about the work you do and where you want to work.", "short_form": "Work and location", "type": "voice", "preferred_answer": null, "required": true } ] }}
Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.
x-secret-key
string
header
required
Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).
Headers
Idempotency-Key
string
Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.
Maximum string length: 255
Body
application/json
name
string
required
Display name, 1–120 characters.
Required string length: 1 - 120
schedule
object
required
Required. Send these six: start_time and end_time ("HH:MM", start before end), days (mon…sun, each once), timezone (IANA), max_retries 1 to 20 and retry_after_hours 1 to 48. language is optional and defaults to english: english, hindi, tamil, kannada, telugu, malayalam, bengali or marathi.
Show child attributes
questions
object[]
required
1 to 15 questions. An enrichment is never edited: different questions mean a new enrichment
Required array length: 1 - 15 elements
Show child attributes
external_id
string
Your own id (1 to 128 of A-Z a-z 0-9 . _ : -)
Pattern: ^[A-Za-z0-9._:-]{1,128}$
description
string
default:""
Optional note, up to 500 characters.
Maximum string length: 500
Response
The new enrichment
success
boolean
message
string
data
object
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Skills \u0026 Verification API","description":"Unified documentation for Skills management and Record Skills Verification APIs.","colors":{"primary":"#E8552D","light":"#FF8A5B","dark":"#C9421F"},"logo":{"light":"https://mintcdn.com/record-54b3228c/woIjJtoIuXBUrrZG/logo/light.png?fit=max\u0026auto=format\u0026n=woIjJtoIuXBUrrZG\u0026q=85\u0026s=1b41928028b76bacc92e4b21adb4a351","dark":"https://mintcdn.com/record-54b3228c/woIjJtoIuXBUrrZG/logo/dark.png?fit=max\u0026auto=format\u0026n=woIjJtoIuXBUrrZG\u0026q=85\u0026s=909623fdf2a5047c6c0c0384860e8137"},"favicon":"https://mintcdn.com/record-54b3228c/woIjJtoIuXBUrrZG/favicon.svg?fit=max\u0026auto=format\u0026n=woIjJtoIuXBUrrZG\u0026q=85\u0026s=b21948aab092a08e2f8086f5d250ed8d","api":{"playground":{"display":"none","proxy":false},"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.example.com/v1"}},"footer":{"socials":{"github":"https://github.com/your-org/skills-api"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"record-54b3228c","hasAudioNarration":false,"actualSubdomain":"record-54b3228c","customDomains":["docs.userecord.io"],"gitSource":{"type":"github","owner":"akshay-record","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b017ccea45c807fee736cec","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Blue Collar API Reference","count":50},{"language":"default","tag":"Blue Collar API Guides","count":15},{"language":"default","tag":"Enrichment API Reference","count":15},{"language":"default","tag":"Campaigns","count":13},{"language":"default","tag":"Integration","count":12},{"language":"default","tag":"Job mandates","count":11},{"language":"default","tag":"Skills","count":11},{"language":"default","tag":"Enrichment API Guides","count":9},{"language":"default","tag":"Results","count":7},{"language":"default","tag":"Get started","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/enrichments/create-an-enrichment","slug":"/api-reference/enrichments/create-an-enrichment","pageMetadata":{"title":"Create an enrichment","description":"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns `enrichment_id`. Record prepares translations and voice in the background: read the enrichment until `questions_status` is `ready`.\n\n**Scope:** `enrichment:write` · **Idempotency-Key:** optional","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json post /enrichments","href":"/api-reference/enrichments/create-an-enrichment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns \", _jsx(_components.code, {\n children: \"enrichment_id\"\n }), \". Record prepares translations and voice in the background: read the enrichment until \", _jsx(_components.code, {\n children: \"questions_status\"\n }), \" is \", _jsx(_components.code, {\n children: \"ready\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"enrichment:write\"\n }), \" · \", _jsx(_components.strong, {\n children: \"Idempotency-Key:\"\n }), \" optional\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an enrichment","description":"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns `enrichment_id`. Record prepares translations and voice in the background: read the enrichment until `questions_status` is `ready`.\n\n**Scope:** `enrichment:write` · **Idempotency-Key:** optional","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json post /enrichments","href":"/api-reference/enrichments/create-an-enrichment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/record-54b3228c/a58523ecb7891034/blue-collar-api/playground-signing.js"],"openApiReferenceData":{"operation":{"operationId":"createEnrichment","tags":["Enrichments"],"summary":"Create an enrichment","description":"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns `enrichment_id`. Record prepares translations and voice in the background: read the enrichment until `questions_status` is `ready`.\n\n**Scope:** `enrichment:write` · **Idempotency-Key:** optional","parameters":["64a6783f-fab1-4f24-b4d3-8bf1c44332a5"],"requestBody":"a4dd9049-2179-4eb8-aa41-d83774df3e73","responses":{"201":"a790a9e8-9e2b-4e4c-a9ed-60323d2949fe","400":"179f664c-f27b-41cf-b637-223e734e2034","403":"d2f4f5a4-7aa0-499e-b2ae-0e73b5e9ccc1","409":"b610747c-3fea-4f5b-8812-efb5f18bb407"},"security":["6a631aef-d182-484a-8dea-a8f73573d718"],"x-codeSamples":[{"lang":"bash","label":"cURL","source":"pcall POST \"/api/v1/partner/enrichments\" '{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}'"},{"lang":"javascript","label":"JavaScript","source":"const res = await call(\"POST\", \"/api/v1/partner/enrichments\", {\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n});\nconst { data } = await res.json();"},{"lang":"python","label":"Python","source":"res = call(\"POST\", \"/api/v1/partner/enrichments\", {\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": True\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": True\n }\n ]\n})\ndata = res.json()[\"data\"]"}],"x-mint":{"metadata":{"playground":"interactive"}},"method":"post","type":"path","servers":["0c402882-e6d8-442c-9eab-b80a82fb50db"],"path":"/enrichments","baseUrlOptions":["https://api-bc.userecord.io/api/v1/partner"],"title":"Create an enrichment","codeSamples":[{"label":"cURL","lang":"bash","source":"pcall POST \"/api/v1/partner/enrichments\" '{\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n}'"},{"label":"JavaScript","lang":"javascript","source":"const res = await call(\"POST\", \"/api/v1/partner/enrichments\", {\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": true\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": true\n }\n ]\n});\nconst { data } = await res.json();"},{"label":"Python","lang":"python","source":"res = call(\"POST\", \"/api/v1/partner/enrichments\", {\n \"external_id\": \"enr-chennai-warehouse\",\n \"name\": \"Warehouse talent pool - Chennai\",\n \"schedule\": {\n \"language\": \"english\",\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\"\n ],\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 3,\n \"retry_after_hours\": 4\n },\n \"questions\": [\n {\n \"question_text\": \"Are you open to a new job right now?\",\n \"type\": \"yes_no\",\n \"preferred_answer\": \"yes\",\n \"required\": True\n },\n {\n \"question_text\": \"Tell us about the work you do and where you want to work.\",\n \"type\": \"voice\",\n \"required\": True\n }\n ]\n})\ndata = res.json()[\"data\"]"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"64a6783f-fab1-4f24-b4d3-8bf1c44332a5":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.","uniqueKey":"","typeLabel":"string"},"description":"Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"Display name, 1–120 characters.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"schedule":{"type":"object","properties":{"start_time":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"Send window start, HH:MM (24-hour)","isRequired":true,"uniqueKey":"schedule.start_time","typeLabel":"string"},"end_time":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"Send window end, HH:MM (24-hour)","isRequired":true,"uniqueKey":"schedule.end_time","typeLabel":"string"},"days":{"type":"array","items":{"type":"string","enum":["mon","tue","wed","thu","fri","sat","sun"],"uniqueKey":"schedule.days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"maxItems":7,"description":"Days messages and calls may go out, each listed once","uniqueItems":true,"isRequired":true,"uniqueKey":"schedule.days","typeLabel":"enum\u003cstring>[]"},"timezone":{"type":"string","maxLength":64,"isRequired":true,"uniqueKey":"schedule.timezone","typeLabel":"string"},"max_retries":{"type":"integer","minimum":1,"maximum":20,"description":"Follow-up call attempts, 1 to 20","isRequired":true,"uniqueKey":"schedule.max_retries","typeLabel":"integer"},"retry_after_hours":{"type":"integer","minimum":1,"maximum":48,"description":"Hours before a retry, 1 to 48","isRequired":true,"uniqueKey":"schedule.retry_after_hours","typeLabel":"integer"},"language":{"type":"string","enum":["english","tamil","hindi","kannada","telugu","malayalam","bengali","marathi"],"default":"english","description":"Opening language of messages and calls (the candidate can switch)","uniqueKey":"schedule.language","typeLabel":"enum\u003cstring>"}},"required":["start_time","end_time","days","timezone","max_retries","retry_after_hours"],"additionalProperties":false,"description":"Required. Send these six: `start_time` and `end_time` (\"HH:MM\", start before end), `days` (mon…sun, each once), `timezone` (IANA), `max_retries` 1 to 20 and `retry_after_hours` 1 to 48. `language` is optional and defaults to `english`: english, hindi, tamil, kannada, telugu, malayalam, bengali or marathi.","isRequired":true,"uniqueKey":"schedule","typeLabel":"object"},"questions":{"type":"array","items":{"type":"object","properties":{"question_text":{"type":"string","minLength":1,"maxLength":300,"description":"What Record asks the candidate, up to 300 characters","isRequired":true,"uniqueKey":"questions.items.[INDEX].question_text","typeLabel":"string"},"type":{"type":"string","enum":["yes_no","voice"],"description":"yes_no is answered with a tap, voice is spoken or recorded","isRequired":true,"uniqueKey":"questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"preferred_answer":{"type":"string","enum":["yes","no"],"description":"Required for yes_no: the answer that counts as qualified","uniqueKey":"questions.items.[INDEX].preferred_answer","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"description":"A candidate completes only after answering every required question","uniqueKey":"questions.items.[INDEX].required","typeLabel":"boolean"}},"required":["question_text","type"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":15,"description":"1 to 15 questions. An enrichment is never edited: different questions mean a new enrichment","isRequired":true,"uniqueKey":"questions","typeLabel":"object[]"},"external_id":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$","description":"Your own id (1 to 128 of A-Z a-z 0-9 . _ : -)","uniqueKey":"external_id","typeLabel":"string"},"description":{"type":"string","maxLength":500,"default":"","description":"Optional note, up to 500 characters.","uniqueKey":"description","typeLabel":"string"}},"required":["name","schedule","questions"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"external_id":"enr-chennai-warehouse","name":"Warehouse talent pool - Chennai","schedule":{"language":"english","start_time":"10:00","end_time":"18:00","days":["mon","tue","wed","thu","fri","sat"],"timezone":"Asia/Kolkata","max_retries":3,"retry_after_hours":4},"questions":[{"question_text":"Are you open to a new job right now?","type":"yes_no","preferred_answer":"yes","required":true},{"question_text":"Tell us about the work you do and where you want to work.","type":"voice","required":true}]},"examples":{"Example":{"title":"Example","value":{"external_id":"enr-chennai-warehouse","name":"Warehouse talent pool - Chennai","schedule":{"language":"english","start_time":"10:00","end_time":"18:00","days":["mon","tue","wed","thu","fri","sat"],"timezone":"Asia/Kolkata","max_retries":3,"retry_after_hours":4},"questions":[{"question_text":"Are you open to a new job right now?","type":"yes_no","preferred_answer":"yes","required":true},{"question_text":"Tell us about the work you do and where you want to work.","type":"voice","required":true}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"a790a9e8-9e2b-4e4c-a9ed-60323d2949fe":{"description":"The new enrichment","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"const":true,"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"enrichment_id":{"type":"string","uniqueKey":"data.enrichment_id","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","uniqueKey":"data.external_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.external_id","typeLabel":"string | null"},"name":{"type":"string","uniqueKey":"data.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"data.description","typeLabel":"string"},"status":{"type":"string","enum":["active","archived"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"questions_status":{"type":"string","enum":["pending","ready","failed"],"description":"Translation and voice of the questions. Campaigns wait for ready, then go out by themselves; failed is retried when you create a campaign","uniqueKey":"data.questions_status","typeLabel":"enum\u003cstring>"},"delivery":{"type":"object","properties":{"whatsapp":{"type":"boolean","uniqueKey":"data.delivery.whatsapp","typeLabel":"boolean"},"voice_call":{"type":"boolean","uniqueKey":"data.delivery.voice_call","typeLabel":"boolean"},"sms":{"type":"boolean","uniqueKey":"data.delivery.sms","typeLabel":"boolean"}},"uniqueKey":"data.delivery","typeLabel":"object"},"schedule":{"type":"object","properties":{"language":{"type":"string","uniqueKey":"data.schedule.language","typeLabel":"string"},"start_time":{"type":"string","uniqueKey":"data.schedule.start_time","typeLabel":"string"},"end_time":{"type":"string","uniqueKey":"data.schedule.end_time","typeLabel":"string"},"days":{"type":"array","items":{"type":"string","uniqueKey":"data.schedule.days.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.schedule.days","typeLabel":"string[]"},"timezone":{"type":"string","uniqueKey":"data.schedule.timezone","typeLabel":"string"},"max_retries":{"type":"integer","uniqueKey":"data.schedule.max_retries","typeLabel":"integer"},"retry_after_hours":{"type":"integer","uniqueKey":"data.schedule.retry_after_hours","typeLabel":"integer"}},"uniqueKey":"data.schedule","typeLabel":"object"},"question_count":{"type":"integer","uniqueKey":"data.question_count","typeLabel":"integer"},"counts":{"type":"object","properties":{"campaigns":{"type":"integer","uniqueKey":"data.counts.campaigns","typeLabel":"integer"},"candidates":{"type":"integer","uniqueKey":"data.counts.candidates","typeLabel":"integer"},"sent":{"type":"integer","description":"Candidates whose WhatsApp invite went out","uniqueKey":"data.counts.sent","typeLabel":"integer"},"completed":{"type":"integer","description":"Candidates who finished, including those who declined","uniqueKey":"data.counts.completed","typeLabel":"integer"}},"uniqueKey":"data.counts","typeLabel":"object"},"is_external":{"type":"boolean","description":"true when created through the Partner API, false when made in the Record playground","uniqueKey":"data.is_external","typeLabel":"boolean"},"created_at":{"type":"string","uniqueKey":"data.created_at","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.updated_at","typeLabel":"string"},"questions":{"type":"array","items":{"type":"object","properties":{"question_id":{"type":"string","uniqueKey":"data.questions.items.[INDEX].question_id","typeLabel":"string"},"order":{"type":"integer","uniqueKey":"data.questions.items.[INDEX].order","typeLabel":"integer"},"question_text":{"type":"string","uniqueKey":"data.questions.items.[INDEX].question_text","typeLabel":"string"},"short_form":{"type":"string","uniqueKey":"data.questions.items.[INDEX].short_form","typeLabel":"string"},"type":{"type":"string","enum":["yes_no","voice"],"uniqueKey":"data.questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"preferred_answer":{"oneOf":[{"type":"string","uniqueKey":"data.questions.items.[INDEX].preferred_answer.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.questions.items.[INDEX].preferred_answer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.questions.items.[INDEX].preferred_answer","typeLabel":"string | null"},"required":{"type":"boolean","uniqueKey":"data.questions.items.[INDEX].required","typeLabel":"boolean"}},"uniqueKey":"data.questions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.questions","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"enrichment_id":"WF_EN_261121094822026AEDRUB86TQVSML","external_id":"enr-chennai-warehouse","name":"Warehouse talent pool - Chennai","description":"","status":"active","questions_status":"pending","delivery":{"whatsapp":true,"voice_call":true,"sms":true},"schedule":{"language":"english","start_time":"10:00","end_time":"18:00","days":["mon","tue","wed","thu","fri","sat"],"timezone":"Asia/Kolkata","max_retries":3,"retry_after_hours":4},"question_count":2,"counts":{"campaigns":0,"candidates":0,"sent":0,"completed":0},"is_external":true,"created_at":"2026-11-10T10:15:30.000Z","updated_at":"2026-11-10T10:15:30.000Z","questions":[{"question_id":"eqq_cc9800817588972e","order":0,"question_text":"Are you open to a new job right now?","short_form":"Open to work","type":"yes_no","preferred_answer":"yes","required":true},{"question_id":"eqq_7a31f0c2d95b84e6","order":1,"question_text":"Tell us about the work you do and where you want to work.","short_form":"Work and location","type":"voice","preferred_answer":null,"required":true}]}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"enrichment_id":"WF_EN_261121094822026AEDRUB86TQVSML","external_id":"enr-chennai-warehouse","name":"Warehouse talent pool - Chennai","description":"","status":"active","questions_status":"pending","delivery":{"whatsapp":true,"voice_call":true,"sms":true},"schedule":{"language":"english","start_time":"10:00","end_time":"18:00","days":["mon","tue","wed","thu","fri","sat"],"timezone":"Asia/Kolkata","max_retries":3,"retry_after_hours":4},"question_count":2,"counts":{"campaigns":0,"candidates":0,"sent":0,"completed":0},"is_external":true,"created_at":"2026-11-10T10:15:30.000Z","updated_at":"2026-11-10T10:15:30.000Z","questions":[{"question_id":"eqq_cc9800817588972e","order":0,"question_text":"Are you open to a new job right now?","short_form":"Open to work","type":"yes_no","preferred_answer":"yes","required":true},{"question_id":"eqq_7a31f0c2d95b84e6","order":1,"question_text":"Tell us about the work you do and where you want to work.","short_form":"Work and location","type":"voice","preferred_answer":null,"required":true}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"179f664c-f27b-41cf-b637-223e734e2034":{"description":"`VALIDATION_FAILED`: `name`, `schedule` or `questions` missing, a `yes_no` question without `preferred_answer`, `start_time` not before `end_time`, an unknown language, empty or repeated `days`, or an unknown field.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"const":false,"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","LIMIT_EXCEEDED","UNAUTHORIZED","SCOPE_MISSING","FORBIDDEN","HTTPS_REQUIRED","NOT_FOUND","CONFLICT","INSUFFICIENT_CREDITS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_IN_PROGRESS","PAYLOAD_TOO_LARGE","UNSUPPORTED_MEDIA_TYPE","RATE_LIMITED","COOLDOWN","DAILY_CAP","SERVICE_DISABLED","SERVER_ERROR"],"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","description":"Quote it to Record support","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}],"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d2f4f5a4-7aa0-499e-b2ae-0e73b5e9ccc1":{"description":"`FORBIDDEN`: A TEST key's organisation already has 5 active enrichments. Archive one in the Record playground.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"const":false,"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","LIMIT_EXCEEDED","UNAUTHORIZED","SCOPE_MISSING","FORBIDDEN","HTTPS_REQUIRED","NOT_FOUND","CONFLICT","INSUFFICIENT_CREDITS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_IN_PROGRESS","PAYLOAD_TOO_LARGE","UNSUPPORTED_MEDIA_TYPE","RATE_LIMITED","COOLDOWN","DAILY_CAP","SERVICE_DISABLED","SERVER_ERROR"],"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","description":"Quote it to Record support","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}],"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b610747c-3fea-4f5b-8812-efb5f18bb407":{"description":"`CONFLICT`: `external_id` is already used by another enrichment.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"const":false,"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","LIMIT_EXCEEDED","UNAUTHORIZED","SCOPE_MISSING","FORBIDDEN","HTTPS_REQUIRED","NOT_FOUND","CONFLICT","INSUFFICIENT_CREDITS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_IN_PROGRESS","PAYLOAD_TOO_LARGE","UNSUPPORTED_MEDIA_TYPE","RATE_LIMITED","COOLDOWN","DAILY_CAP","SERVICE_DISABLED","SERVER_ERROR"],"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","description":"Quote it to Record support","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}],"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6a631aef-d182-484a-8dea-a8f73573d718":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request.","scopes":[],"schemeName":"ApiKey"},"SecretKey":{"type":"apiKey","in":"header","name":"x-secret-key","description":"Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication).","scopes":[],"schemeName":"SecretKey"}}},"servers":{"0c402882-e6d8-442c-9eab-b80a82fb50db":{"url":"https://api-bc.userecord.io/api/v1/partner","description":"Enrichment API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request.","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"x-api-key","type":"string","description":"Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"},{"scheme":{"type":"apiKey","in":"header","name":"x-secret-key","description":"Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication).","scopes":[],"schemeName":"SecretKey"},"schema":{"title":"x-secret-key","type":"string","description":"Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"SecretKey","name":"x-secret-key"}],"title":"ApiKey \u0026 SecretKey"}]},"originalFileLocation":"enrichment-api/api-reference/openapi.json"},"subdomain":"record-54b3228c","siteName":"Skills \u0026 Verification API","title":"Create an enrichment - Skills \u0026 Verification API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T15:57:22.473Z","originalFileLocation":"api-reference/enrichments/create-an-enrichment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns enrichment_id. Record prepares translations and voice in the background: read the enrichment until questions_status is ready. Scope: enrichment:write · Idempotency-Key: optional\">\u003cmeta data-mint-head name=\"application-name\" content=\"Skills \u0026amp; Verification API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an enrichment - Skills \u0026amp; Verification API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns enrichment_id. Record prepares translations and voice in the background: read the enrichment until questions_status is ready. Scope: enrichment:write · Idempotency-Key: optional\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Skills \u0026amp; Verification API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://record-54b3228c.mintlify.site/_mintlify/api/og/v2?division=Enrichments\u0026amp;title=Create+an+enrichment\u0026amp;description=Create+the+questions+you+want+candidates+to+answer+and+the+window+they+are+contacted+in.+It+is+created+once+and+never+edited%3A+different+questions+mean+a+new+enr\u0026amp;theme=34401d554bd19e9db05353b3\u0026amp;signature=b7c76e8fb67874e2e85f7946579041f21535750c72b0caf126f71c2c78407d27\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an enrichment - Skills \u0026amp; Verification API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns enrichment_id. Record prepares translations and voice in the background: read the enrichment until questions_status is ready. Scope: enrichment:write · Idempotency-Key: optional\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://record-54b3228c.mintlify.site/_mintlify/api/og/v2?division=Enrichments\u0026amp;title=Create+an+enrichment\u0026amp;description=Create+the+questions+you+want+candidates+to+answer+and+the+window+they+are+contacted+in.+It+is+created+once+and+never+edited%3A+different+questions+mean+a+new+enr\u0026amp;theme=34401d554bd19e9db05353b3\u0026amp;signature=b7c76e8fb67874e2e85f7946579041f21535750c72b0caf126f71c2c78407d27\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/record-54b3228c/52cK48xSzJuWEkAi/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Skills \u0026amp; Verification API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E8552D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/enrichments/create-an-enrichment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.userecord.io/#organization\",\"name\":\"Skills \u0026 Verification API\",\"url\":\"https://docs.userecord.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/record-54b3228c/woIjJtoIuXBUrrZG/logo/light.png?fit=max\u0026auto=format\u0026n=woIjJtoIuXBUrrZG\u0026q=85\u0026s=1b41928028b76bacc92e4b21adb4a351\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.userecord.io#website\",\"name\":\"Skills \u0026 Verification API\",\"url\":\"https://docs.userecord.io\",\"publisher\":{\"@id\":\"https://docs.userecord.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment#webpage\",\"url\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment\",\"name\":\"Create an enrichment\",\"description\":\"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns enrichment_id. Record prepares translations and voice in the background: read the enrichment until questions_status is ready. Scope: enrichment:write · Idempotency-Key: optional\",\"dateModified\":\"2026-11-20T15:57:22.473Z\",\"isPartOf\":{\"@id\":\"https://docs.userecord.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Skills \u0026 Verification API\",\"item\":\"https://docs.userecord.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an enrichment\",\"item\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment#apireference\",\"headline\":\"Create an enrichment\",\"name\":\"Create an enrichment\",\"description\":\"Create the questions you want candidates to answer and the window they are contacted in. It is created once and never edited: different questions mean a new enrichment. Returns enrichment_id. Record prepares translations and voice in the background: read the enrichment until questions_status is ready. Scope: enrichment:write · Idempotency-Key: optional\",\"url\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userecord.io/api-reference/enrichments/create-an-enrichment#webpage\"},\"dateModified\":\"2026-11-20T15:57:22.473Z\",\"publisher\":{\"@id\":\"https://docs.userecord.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.userecord.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Skills \u0026 Verification API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Skills \u0026 Verification API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/enrichments/create-an-enrichment.md","siteName":"Skills \u0026 Verification API","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","hidden":true,"pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"Skills Verification","hidden":true,"pages":[{"title":"Skills Verification","href":"/api-reference/introduction"}]},{"tab":"Skills Issuance","hidden":true,"pages":[{"title":"Skills Issuance","href":"/api-reference/issuance/introduction"}]},{"tab":"SmartAI Assessment SDK","hidden":true,"pages":[{"title":"SmartAI Assessment SDK","href":"/smartai/introduction"}]},{"tab":"WhiteCollar Assessments","hidden":true,"pages":[{"title":"WhiteCollar Assessments","href":"/whitecollar/introduction"}]},{"tab":"Blue Collar API Guides","pages":[{"title":"Blue Collar API Guides","href":"/blue-collar-api"}]},{"tab":"Blue Collar API Reference","pages":[{"title":"Blue Collar API Reference","href":"/blue-collar-api/api-reference/introduction"}]},{"tab":"Enrichment API Guides","pages":[{"title":"Enrichment API Guides","href":"/enrichment-api"}]},{"tab":"Enrichment API Reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","description":"Every Enrichment API endpoint, with its request and response schema.","href":"/enrichment-api/api-reference/introduction"}]},{"group":"Enrichments","pages":[{"title":"Create an enrichment","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json post /enrichments","href":"/api-reference/enrichments/create-an-enrichment"},{"title":"List enrichments","description":"List your organisation's enrichments, made here or on the Enrichment page of the playground (`is_external` says which), newest first.\n\n**Scope:** `enrichment:read` or `enrichment:write` or `enrichment:campaigns`","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments","href":"/api-reference/enrichments/list-enrichments"},{"title":"Get an enrichment","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}","href":"/api-reference/enrichments/get-an-enrichment"},{"title":"Get the overview of an enrichment","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/overview","href":"/api-reference/enrichments/get-the-overview-of-an-enrichment"}]},{"group":"Campaigns","pages":[{"title":"Create a campaign","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json post /enrichments/{enrichment_id}/campaigns","href":"/api-reference/enrichment-campaigns/create-a-campaign"},{"title":"List campaigns","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/campaigns","href":"/api-reference/enrichment-campaigns/list-campaigns"},{"title":"Get a campaign","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/campaigns/{campaign_id}","href":"/api-reference/enrichment-campaigns/get-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json post /enrichments/{enrichment_id}/campaigns/{campaign_id}/pause","href":"/api-reference/enrichment-campaigns/pause-a-campaign"},{"title":"Resume a campaign","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json post /enrichments/{enrichment_id}/campaigns/{campaign_id}/resume","href":"/api-reference/enrichment-campaigns/resume-a-campaign"}]},{"group":"Candidates","pages":[{"title":"List candidates","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/candidates","href":"/api-reference/enrichment-candidates/list-candidates"},{"title":"Get a candidate","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/candidates/{candidate_id}","href":"/api-reference/enrichment-candidates/get-a-candidate"}]},{"group":"Results","pages":[{"title":"List results","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/results","href":"/api-reference/enrichment-results/list-results"}]},{"group":"Credits","pages":[{"title":"Your available credits","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichment-credits","href":"/api-reference/enrichment-credits/your-available-credits"},{"title":"Where your enrichment credits were used","deprecated":null,"version":null,"playground":"interactive","openapi":"/enrichment-api/api-reference/openapi.json get /enrichment-credits/usage","href":"/api-reference/enrichment-credits/where-your-enrichment-credits-were-used"}]}]},{"tab":"Meta Config","hidden":true,"pages":[{"title":"Meta Config","href":"/meta-x-record"}]},{"tab":"Policies and Data Security","hidden":true,"pages":[{"title":"Policies and Data Security","href":"/terms-and-conditions"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create an enrichment - Skills \u0026 Verification API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}