Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns campaign_id, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first.
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
Path Parameters
enrichment_id
string
required
Pattern: ^WF_[A-Z]{2}_[A-Z0-9]{10,40}$
Body
application/json
name
string
required
Campaign name, 1–200 characters.
Required string length: 1 - 200
candidates
object[]
required
Required. 1 to 1,000 of { name, phone_number, external_id? }. phone_number is an Indian mobile: 10 digits, or with +91. A row with an invalid number, a number that opted out, or a number already earlier in the list is skipped and returned in skipped; it never fails the call. external_id comes back on every candidate and result.
Required array length: 1 - 1000 elements
Show child attributes
language
enum<string>
Invite language; defaults to the enrichment's schedule language
Available options:
english,
tamil,
hindi,
kannada,
telugu,
malayalam,
bengali,
marathi
Response
The new campaign, its candidates and the rows skipped
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/enrichment-campaigns/create-a-campaign","slug":"/api-reference/enrichment-campaigns/create-a-campaign","pageMetadata":{"title":"Create a campaign","description":"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns `campaign_id`, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first.\n\n**Scope:** `enrichment:campaigns` · **Idempotency-Key:** optional\n\n> **This contacts real candidates.** Build against a TEST key first.","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","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 blockquote: \"blockquote\",\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: [\"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns \", _jsx(_components.code, {\n children: \"campaign_id\"\n }), \", the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"enrichment:campaigns\"\n }), \" · \", _jsx(_components.strong, {\n children: \"Idempotency-Key:\"\n }), \" optional\"]\n }), \"\\n\", _jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"This contacts real candidates.\"\n }), \" Build against a TEST key first.\"]\n }), \"\\n\"]\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 a campaign","description":"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns `campaign_id`, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first.\n\n**Scope:** `enrichment:campaigns` · **Idempotency-Key:** optional\n\n> **This contacts real candidates.** Build against a TEST key first.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/record-54b3228c/a58523ecb7891034/blue-collar-api/playground-signing.js"],"openApiReferenceData":{"operation":{"operationId":"createEnrichmentCampaign","tags":["Enrichment campaigns"],"summary":"Create a campaign","description":"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns `campaign_id`, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first.\n\n**Scope:** `enrichment:campaigns` · **Idempotency-Key:** optional\n\n> **This contacts real candidates.** Build against a TEST key first.","parameters":["c42a59db-6b5f-4720-a45d-fd528e2e810b","5678f32a-2a37-42d5-af08-b03453a3163e"],"requestBody":"44ea4db5-099e-4e42-b356-b9063ee2785f","responses":{"201":"c5566966-f388-4b48-a7d5-b72f448f3ba0","400":"c8ff3a63-f15f-45c5-a7f9-f592c838485e","402":"9038a377-464a-4eb7-8693-8b95160936ca","403":"c2604bdc-6f6c-4ac9-b2e1-b9a718d31561","404":"0006981a-f9de-428b-a7f5-e1df43c8737e","429":"075d2331-8356-420c-882f-29b8ba5d2ab1"},"security":["fd4aa77f-e647-46f7-bf89-7f9850c8af34"],"x-codeSamples":[{"lang":"bash","label":"cURL","source":"pcall POST \"/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/campaigns\" '{\n \"name\": \"November talent pool\",\n \"candidates\": [\n {\n \"name\": \"Ravi Kumar\",\n \"phone_number\": \"9876543210\",\n \"external_id\": \"cand-1001\"\n },\n {\n \"name\": \"Meena S\",\n \"phone_number\": \"9123456780\",\n \"external_id\": \"cand-1002\"\n },\n {\n \"name\": \"Test Number\",\n \"phone_number\": \"0000000000\"\n }\n ]\n}'"},{"lang":"javascript","label":"JavaScript","source":"const res = await call(\"POST\", \"/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/campaigns\", {\n \"name\": \"November talent pool\",\n \"candidates\": [\n {\n \"name\": \"Ravi Kumar\",\n \"phone_number\": \"9876543210\",\n \"external_id\": \"cand-1001\"\n },\n {\n \"name\": \"Meena S\",\n \"phone_number\": \"9123456780\",\n \"external_id\": \"cand-1002\"\n },\n {\n \"name\": \"Test Number\",\n \"phone_number\": \"0000000000\"\n }\n ]\n});\nconst { data } = await res.json();"},{"lang":"python","label":"Python","source":"res = call(\"POST\", \"/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/campaigns\", {\n \"name\": \"November talent pool\",\n \"candidates\": [\n {\n \"name\": \"Ravi Kumar\",\n \"phone_number\": \"9876543210\",\n \"external_id\": \"cand-1001\"\n },\n {\n \"name\": \"Meena S\",\n \"phone_number\": \"9123456780\",\n \"external_id\": \"cand-1002\"\n },\n {\n \"name\": \"Test Number\",\n \"phone_number\": \"0000000000\"\n }\n ]\n})\ndata = res.json()[\"data\"]"}],"x-mint":{"metadata":{"playground":"interactive"}},"method":"post","type":"path","servers":["0c402882-e6d8-442c-9eab-b80a82fb50db"],"path":"/enrichments/{enrichment_id}/campaigns","baseUrlOptions":["https://api-bc.userecord.io/api/v1/partner"],"title":"Create a campaign","codeSamples":[{"label":"cURL","lang":"bash","source":"pcall POST \"/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/campaigns\" '{\n \"name\": \"November talent pool\",\n \"candidates\": [\n {\n \"name\": \"Ravi Kumar\",\n \"phone_number\": \"9876543210\",\n \"external_id\": \"cand-1001\"\n },\n {\n \"name\": \"Meena S\",\n \"phone_number\": \"9123456780\",\n \"external_id\": \"cand-1002\"\n },\n {\n \"name\": \"Test Number\",\n \"phone_number\": \"0000000000\"\n }\n ]\n}'"},{"label":"JavaScript","lang":"javascript","source":"const res = await call(\"POST\", \"/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/campaigns\", {\n \"name\": \"November talent pool\",\n \"candidates\": [\n {\n \"name\": \"Ravi Kumar\",\n \"phone_number\": \"9876543210\",\n \"external_id\": \"cand-1001\"\n },\n {\n \"name\": \"Meena S\",\n \"phone_number\": \"9123456780\",\n \"external_id\": \"cand-1002\"\n },\n {\n \"name\": \"Test Number\",\n \"phone_number\": \"0000000000\"\n }\n ]\n});\nconst { data } = await res.json();"},{"label":"Python","lang":"python","source":"res = call(\"POST\", \"/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/campaigns\", {\n \"name\": \"November talent pool\",\n \"candidates\": [\n {\n \"name\": \"Ravi Kumar\",\n \"phone_number\": \"9876543210\",\n \"external_id\": \"cand-1001\"\n },\n {\n \"name\": \"Meena S\",\n \"phone_number\": \"9123456780\",\n \"external_id\": \"cand-1002\"\n },\n {\n \"name\": \"Test Number\",\n \"phone_number\": \"0000000000\"\n }\n ]\n})\ndata = res.json()[\"data\"]"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"c42a59db-6b5f-4720-a45d-fd528e2e810b":{"name":"enrichment_id","in":"path","required":true,"schema":{"type":"string","pattern":"^WF_[A-Z]{2}_[A-Z0-9]{10,40}$","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"WF_EN_261121094822026AEDRUB86TQVSML"},"5678f32a-2a37-42d5-af08-b03453a3163e":{"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":200,"description":"Campaign name, 1–200 characters.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"candidates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"candidates.items.[INDEX].name","typeLabel":"string"},"phone_number":{"type":"string","minLength":8,"maxLength":20,"description":"An Indian mobile number: 10 digits, or with +91","isRequired":true,"uniqueKey":"candidates.items.[INDEX].phone_number","typeLabel":"string"},"external_id":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$","description":"Your own id for the candidate; returned with their status and results","uniqueKey":"candidates.items.[INDEX].external_id","typeLabel":"string"}},"required":["name","phone_number"],"additionalProperties":false,"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":1000,"description":"Required. 1 to 1,000 of `{ name, phone_number, external_id? }`. `phone_number` is an Indian mobile: 10 digits, or with `+91`. A row with an invalid number, a number that opted out, or a number already earlier in the list is skipped and returned in `skipped`; it never fails the call. `external_id` comes back on every candidate and result.","isRequired":true,"uniqueKey":"candidates","typeLabel":"object[]"},"language":{"type":"string","enum":["english","tamil","hindi","kannada","telugu","malayalam","bengali","marathi"],"description":"Invite language; defaults to the enrichment's schedule language","uniqueKey":"language","typeLabel":"enum\u003cstring>"}},"required":["name","candidates"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"name":"November talent pool","candidates":[{"name":"Ravi Kumar","phone_number":"9876543210","external_id":"cand-1001"},{"name":"Meena S","phone_number":"9123456780","external_id":"cand-1002"},{"name":"Test Number","phone_number":"0000000000"}]},"examples":{"Example":{"title":"Example","value":{"name":"November talent pool","candidates":[{"name":"Ravi Kumar","phone_number":"9876543210","external_id":"cand-1001"},{"name":"Meena S","phone_number":"9123456780","external_id":"cand-1002"},{"name":"Test Number","phone_number":"0000000000"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c5566966-f388-4b48-a7d5-b72f448f3ba0":{"description":"The new campaign, its candidates and the rows skipped","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":{"campaign":{"type":"object","properties":{"campaign_id":{"type":"string","uniqueKey":"data.campaign.campaign_id","typeLabel":"string"},"enrichment_id":{"type":"string","uniqueKey":"data.campaign.enrichment_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.campaign.name","typeLabel":"string"},"language":{"type":"string","uniqueKey":"data.campaign.language","typeLabel":"string"},"status":{"type":"string","enum":["sent","paused","completed","cancelled"],"description":"sent = live","uniqueKey":"data.campaign.status","typeLabel":"enum\u003cstring>"},"awaiting_questions":{"type":"boolean","description":"true while the questions are still being prepared; nothing goes out until they are","uniqueKey":"data.campaign.awaiting_questions","typeLabel":"boolean"},"question_count":{"type":"integer","uniqueKey":"data.campaign.question_count","typeLabel":"integer"},"channels":{"type":"object","properties":{"whatsapp":{"type":"boolean","uniqueKey":"data.campaign.channels.whatsapp","typeLabel":"boolean"},"voice_call":{"type":"boolean","uniqueKey":"data.campaign.channels.voice_call","typeLabel":"boolean"},"sms":{"type":"boolean","uniqueKey":"data.campaign.channels.sms","typeLabel":"boolean"}},"uniqueKey":"data.campaign.channels","typeLabel":"object"},"rejected_count":{"type":"integer","description":"Rows skipped at upload","uniqueKey":"data.campaign.rejected_count","typeLabel":"integer"},"created_at":{"type":"string","uniqueKey":"data.campaign.created_at","typeLabel":"string"},"counts":{"type":"object","properties":{"candidates":{"type":"integer","uniqueKey":"data.campaign.counts.candidates","typeLabel":"integer"},"sent":{"type":"integer","uniqueKey":"data.campaign.counts.sent","typeLabel":"integer"},"completed":{"type":"integer","uniqueKey":"data.campaign.counts.completed","typeLabel":"integer"}},"uniqueKey":"data.campaign.counts","typeLabel":"object"}},"uniqueKey":"data.campaign","typeLabel":"object"},"candidates":{"type":"array","items":{"type":"object","properties":{"candidate_id":{"type":"string","uniqueKey":"data.candidates.items.[INDEX].candidate_id","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","uniqueKey":"data.candidates.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.candidates.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.candidates.items.[INDEX].external_id","typeLabel":"string | null"},"name":{"type":"string","uniqueKey":"data.candidates.items.[INDEX].name","typeLabel":"string"},"phone_number":{"type":"string","uniqueKey":"data.candidates.items.[INDEX].phone_number","typeLabel":"string"}},"uniqueKey":"data.candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.candidates","typeLabel":"object[]"},"skipped":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Position in the candidates you sent, from 0","uniqueKey":"data.skipped.items.[INDEX].index","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"data.skipped.items.[INDEX].name","typeLabel":"string"},"phone_number":{"type":"string","uniqueKey":"data.skipped.items.[INDEX].phone_number","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_phone","opted_out","duplicate"],"uniqueKey":"data.skipped.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.skipped.items.[INDEX]","typeLabel":"object"},"description":"Every row left out and why. Skipped rows are never an error","uniqueKey":"data.skipped","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"campaign":{"campaign_id":"EC_261121095438377TFUX07WN2XT42V","enrichment_id":"WF_EN_261121094822026AEDRUB86TQVSML","name":"November talent pool","language":"english","status":"sent","awaiting_questions":true,"question_count":2,"channels":{"whatsapp":true,"voice_call":true,"sms":true},"rejected_count":1,"created_at":"2026-11-10T10:30:45.000Z","counts":{"candidates":2,"sent":0,"completed":0}},"candidates":[{"candidate_id":"6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33","external_id":"cand-1001","name":"Ravi Kumar","phone_number":"+919876543210"},{"candidate_id":"0c9b7e21-5d3f-4a68-b1e4-77a2c8d9e054","external_id":"cand-1002","name":"Meena S","phone_number":"+919123456780"}],"skipped":[{"index":2,"name":"Test Number","phone_number":"0000000000","reason":"invalid_phone"}]}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"campaign":{"campaign_id":"EC_261121095438377TFUX07WN2XT42V","enrichment_id":"WF_EN_261121094822026AEDRUB86TQVSML","name":"November talent pool","language":"english","status":"sent","awaiting_questions":true,"question_count":2,"channels":{"whatsapp":true,"voice_call":true,"sms":true},"rejected_count":1,"created_at":"2026-11-10T10:30:45.000Z","counts":{"candidates":2,"sent":0,"completed":0}},"candidates":[{"candidate_id":"6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33","external_id":"cand-1001","name":"Ravi Kumar","phone_number":"+919876543210"},{"candidate_id":"0c9b7e21-5d3f-4a68-b1e4-77a2c8d9e054","external_id":"cand-1002","name":"Meena S","phone_number":"+919123456780"}],"skipped":[{"index":2,"name":"Test Number","phone_number":"0000000000","reason":"invalid_phone"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"c8ff3a63-f15f-45c5-a7f9-f592c838485e":{"description":"`VALIDATION_FAILED`: No candidate has a contactable number (`details` say why), or a field is missing or unknown.","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"},"9038a377-464a-4eb7-8693-8b95160936ca":{"description":"`INSUFFICIENT_CREDITS`: The organisation's credits do not cover every candidate in the batch (live wallet for a live key, test wallet for a TEST key). Nothing is created.","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"},"c2604bdc-6f6c-4ac9-b2e1-b9a718d31561":{"description":"`FORBIDDEN`: A TEST key would exceed 50 candidates in this 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"},"0006981a-f9de-428b-a7f5-e1df43c8737e":{"description":"`NOT_FOUND`: No such enrichment, or it is archived.","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"},"075d2331-8356-420c-882f-29b8ba5d2ab1":{"description":"`DAILY_CAP`: The key has put its daily allowance of different people into campaigns (2,000, or 200 for a TEST key). Resets at midnight IST.","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":{"fd4aa77f-e647-46f7-bf89-7f9850c8af34":{"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 a campaign - Skills \u0026 Verification API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T15:57:22.550Z","originalFileLocation":"api-reference/enrichment-campaigns/create-a-campaign.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=\"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns campaign_id, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first. Scope: enrichment:campaigns · Idempotency-Key: optional \u0026gt; This contacts real candidates. Build against a TEST key first.\">\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 a campaign - Skills \u0026amp; Verification API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns campaign_id, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first. Scope: enrichment:campaigns · Idempotency-Key: optional \u0026gt; This contacts real candidates. Build against a TEST key first.\">\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/enrichment-campaigns/create-a-campaign\">\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=Campaigns\u0026amp;title=Create+a+campaign\u0026amp;description=Add+candidates+%28name+and+mobile+number%29+to+one+of+your+enrichments.+Record+starts+contacting+them+straight+away%3A+there+is+no+separate+start+step.+If+the+questio\u0026amp;theme=34401d554bd19e9db05353b3\u0026amp;signature=8f884a764a8b693d6fef90e14d7215d807bd731d1b1222d3b091e9b79cb4afe9\">\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 a campaign - Skills \u0026amp; Verification API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns campaign_id, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first. Scope: enrichment:campaigns · Idempotency-Key: optional \u0026gt; This contacts real candidates. Build against a TEST key first.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://record-54b3228c.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+a+campaign\u0026amp;description=Add+candidates+%28name+and+mobile+number%29+to+one+of+your+enrichments.+Record+starts+contacting+them+straight+away%3A+there+is+no+separate+start+step.+If+the+questio\u0026amp;theme=34401d554bd19e9db05353b3\u0026amp;signature=8f884a764a8b693d6fef90e14d7215d807bd731d1b1222d3b091e9b79cb4afe9\">\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/enrichment-campaigns/create-a-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/enrichment-campaigns/create-a-campaign.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/enrichment-campaigns/create-a-campaign#webpage\",\"url\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign\",\"name\":\"Create a campaign\",\"description\":\"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns campaign_id, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first. Scope: enrichment:campaigns · Idempotency-Key: optional > This contacts real candidates. Build against a TEST key first.\",\"dateModified\":\"2026-11-20T15:57:22.550Z\",\"isPartOf\":{\"@id\":\"https://docs.userecord.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Skills \u0026 Verification API\",\"item\":\"https://docs.userecord.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a campaign\",\"item\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign#apireference\",\"headline\":\"Create a campaign\",\"name\":\"Create a campaign\",\"description\":\"Add candidates (name and mobile number) to one of your enrichments. Record starts contacting them straight away: there is no separate start step. If the questions are still being prepared, the campaign waits and goes out by itself. Returns campaign_id, the candidates and every row that was skipped. Credits are charged per candidate added and checked for the whole batch first. Scope: enrichment:campaigns · Idempotency-Key: optional > This contacts real candidates. Build against a TEST key first.\",\"url\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userecord.io/api-reference/enrichment-campaigns/create-a-campaign#webpage\"},\"dateModified\":\"2026-11-20T15:57:22.550Z\",\"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/enrichment-campaigns/create-a-campaign.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","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","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","description":"Funnel numbers across all campaigns: uploaded, rejected, sent, delivered, link opened, completed and opted out, and how many candidates stand in each status.\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/{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","description":"The campaigns of an enrichment, newest first, with how many candidates were sent to and finished.\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/{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 a campaign - 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"]}