Use this API to invite one candidate at a time. The endpoint creates the interview, emails the invitation to the candidate, and returns the direct interview link.
Rate limit: 100 requests per minute per API key. Requests over the limit return 429 Too Many Requests.
Request body fields
string
required
Candidate’s full name. Maximum 255 characters. Blank names are rejected.
string
required
Candidate’s email address. The value is normalized to lowercase.
string
required
The UUID of the Interviewer to create the interview under. Archived Interviewers are rejected.
string
shortlisted or draft. If omitted, public Interviewers default to shortlisted and private Interviewers default to draft.
string
A publicly accessible URL to the Candidate’s resume (PDF). InterviewFlowAI downloads the file and stores it as a PDF. If the download fails, the interview is still created, without a resume, and no error is returned.
string[]
Skill names used to generate skill-based custom interview questions. If generation fails, the request returns 500 “Failed to generate skill test questions”.
object[]
Candidate-specific custom questions to attach to the interview.
object
Custom Candidate fields configured in InterviewFlowAI.
object
External reference data such as ATS IDs. metadata.phoneNumber sets the Candidate’s phone number.
Candidate already has an interview for the same Interviewer
The request is rejected and no new interview is created.
jobId doesn’t exist or belongs to another Company
404 “Job not found or does not belong to this account”.
Interviewer is archived
400 “Cannot create interviews for archived jobs”.
status is shortlisted
The returned link takes the candidate directly to the interview flow.
status is draft
The interview is created as a draft candidate record.
Interviewer is public and status is omitted
The interview is created as shortlisted.
Interviewer is private and status is omitted
The interview is created as draft.
Use this endpoint when your ATS, CRM, or internal system also needs the interview link, for example to store it on the candidate record.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"InterviewFlowAI Knowledge Base","colors":{"primary":"#5B50D6","light":"#8E85F2","dark":"#463CC0"},"logo":{"light":"https://mintcdn.com/interviewflowai/3Gmnw_L8IR0faXhJ/logo/logo.png?fit=max\u0026auto=format\u0026n=3Gmnw_L8IR0faXhJ\u0026q=85\u0026s=2eefa6ed5f15b3b9fe696130b4e91d1a","dark":"https://mintcdn.com/interviewflowai/HHntDfCf9L_iX9_5/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=HHntDfCf9L_iX9_5\u0026q=85\u0026s=b6a48ac6c4168660ec1887845e784135"},"favicon":"https://mintcdn.com/interviewflowai/QTePgE545nTugw-v/favicon.png?fit=max\u0026auto=format\u0026n=QTePgE545nTugw-v\u0026q=85\u0026s=0b8290bc9a3e6ea91ca417135d5e3f5d","api":{"playground":{"display":"interactive"},"examples":{"autogenerate":false},"mdx":{"auth":{"method":"key","name":"X-API-KEY"},"server":"https://api.interviewflowai.com"}},"background":{"color":{"light":"#FCFCFD","dark":"#0F0E1A"}},"navbar":{"links":[{"href":"mailto:support@interviewflowai.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.interviewflowai.com"}},"footer":{"socials":{"x":"https://x.com/interviewflowai","linkedin":"https://linkedin.com/company/interviewflowai"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://interviewflowai.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"interviewflowai","hasAudioNarration":false,"actualSubdomain":"interviewflowai","customDomains":["docs.interviewflowai.com"],"gitSource":{"type":"github","owner":"imukulmunjal","repo":"docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af9fc960752de1b55396b93","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Guides","count":48},{"language":"default","tag":"Main","count":31},{"language":"default","tag":"Interviewers","count":24},{"language":"default","tag":"API reference","count":13},{"language":"default","tag":"Create an AI Interviewer","count":7},{"language":"default","tag":"ATS \u0026 Integrations","count":7},{"language":"default","tag":"Settings","count":6},{"language":"default","tag":"Configuration","count":6},{"language":"default","tag":"Candidates","count":5},{"language":"default","tag":"Getting started","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"img[src*=\"/logo/logo\"]{transform:scale(1.2)!important;transform-origin:left center!important}"}],"page":{"pagePath":"api-reference/candidates/invite","slug":"/api-reference/candidates/invite","pageMetadata":{"title":"Invite a Candidate","description":"Invite one Candidate and get their interview link.","api":"POST /api/external/ingest/candidate","href":"/api-reference/candidates/invite"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Invite one Candidate and get their interview link.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,ParamField,Table,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this API to invite one candidate at a time. The endpoint creates the interview, emails the invitation to the candidate, and returns the direct interview link.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 100 requests per minute per API key. Requests over the limit return `,_jsx(_components.code,{children:`429 Too Many Requests`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body-fields`,children:`Request body fields`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`Candidate’s full name. Maximum 255 characters. Blank names are rejected.`})}),`\n`,_jsx(ParamField,{body:`email`,type:`string`,required:true,id:`param-email`,children:_jsx(_components.p,{children:`Candidate’s email address. The value is normalized to lowercase.`})}),`\n`,_jsx(ParamField,{body:`jobId`,type:`string`,required:true,id:`param-job-id`,children:_jsx(_components.p,{children:`The UUID of the Interviewer to create the interview under. Archived Interviewers are rejected.`})}),`\n`,_jsx(ParamField,{body:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`shortlisted`}),` or `,_jsx(_components.code,{children:`draft`}),`. If omitted, public Interviewers default to `,_jsx(_components.code,{children:`shortlisted`}),` and private Interviewers default to `,_jsx(_components.code,{children:`draft`}),`.`]})}),`\n`,_jsx(ParamField,{body:`resumeUrl`,type:`string`,id:`param-resume-url`,children:_jsx(_components.p,{children:`A publicly accessible URL to the Candidate’s resume (PDF). InterviewFlowAI downloads the file and stores it as a PDF. If the download fails, the interview is still created, without a resume, and no error is returned.`})}),`\n`,_jsx(ParamField,{body:`skills`,type:`string[]`,id:`param-skills`,children:_jsxs(_components.p,{children:[`Skill names used to generate skill-based custom interview questions. If generation fails, the request returns `,_jsx(_components.code,{children:`500`}),` “Failed to generate skill test questions”.`]})}),`\n`,_jsx(ParamField,{body:`customQuestions`,type:`object[]`,id:`param-custom-questions`,children:_jsx(_components.p,{children:`Candidate-specific custom questions to attach to the interview.`})}),`\n`,_jsx(ParamField,{body:`additionalFields`,type:`object`,id:`param-additional-fields`,children:_jsx(_components.p,{children:`Custom Candidate fields configured in InterviewFlowAI.`})}),`\n`,_jsx(ParamField,{body:`metadata`,type:`object`,id:`param-metadata`,children:_jsxs(_components.p,{children:[`External reference data such as ATS IDs. `,_jsx(_components.code,{children:`metadata.phoneNumber`}),` sets the Candidate’s phone number.`]})}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`behavior`,children:`Behavior`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Scenario`}),_jsx(_components.th,{children:`Behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Candidate already has an interview for the same Interviewer`}),_jsx(_components.td,{children:`The request is rejected and no new interview is created.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`jobId`}),` doesn’t exist or belongs to another Company`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`404`}),` “Job not found or does not belong to this account”.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Interviewer is archived`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`400`}),` “Cannot create interviews for archived jobs”.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`shortlisted`})]}),_jsx(_components.td,{children:`The returned link takes the candidate directly to the interview flow.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`draft`})]}),_jsx(_components.td,{children:`The interview is created as a draft candidate record.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Interviewer is public and `,_jsx(_components.code,{children:`status`}),` is omitted`]}),_jsxs(_components.td,{children:[`The interview is created as `,_jsx(_components.code,{children:`shortlisted`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Interviewer is private and `,_jsx(_components.code,{children:`status`}),` is omitted`]}),_jsxs(_components.td,{children:[`The interview is created as `,_jsx(_components.code,{children:`draft`}),`.`]})]})]})]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Use this endpoint when your ATS, CRM, or internal system also needs the interview link, for example to store it on the candidate record.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Invite a Candidate","description":"Invite one Candidate and get their interview link.","api":"POST /api/external/ingest/candidate","href":"/api-reference/candidates/invite"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this API to invite one candidate at a time. The endpoint creates the interview, emails the invitation to the candidate, and returns the direct interview link.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 100 requests per minute per API key. Requests over the limit return `,_jsx(_components.code,{children:`429 Too Many Requests`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body-fields`,children:`Request body fields`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`Candidate’s full name. Maximum 255 characters. Blank names are rejected.`})}),`\n`,_jsx(ParamField,{body:`email`,type:`string`,required:true,id:`param-email`,children:_jsx(_components.p,{children:`Candidate’s email address. The value is normalized to lowercase.`})}),`\n`,_jsx(ParamField,{body:`jobId`,type:`string`,required:true,id:`param-job-id`,children:_jsx(_components.p,{children:`The UUID of the Interviewer to create the interview under. Archived Interviewers are rejected.`})}),`\n`,_jsx(ParamField,{body:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`shortlisted`}),` or `,_jsx(_components.code,{children:`draft`}),`. If omitted, public Interviewers default to `,_jsx(_components.code,{children:`shortlisted`}),` and private Interviewers default to `,_jsx(_components.code,{children:`draft`}),`.`]})}),`\n`,_jsx(ParamField,{body:`resumeUrl`,type:`string`,id:`param-resume-url`,children:_jsx(_components.p,{children:`A publicly accessible URL to the Candidate’s resume (PDF). InterviewFlowAI downloads the file and stores it as a PDF. If the download fails, the interview is still created, without a resume, and no error is returned.`})}),`\n`,_jsx(ParamField,{body:`skills`,type:`string[]`,id:`param-skills`,children:_jsxs(_components.p,{children:[`Skill names used to generate skill-based custom interview questions. If generation fails, the request returns `,_jsx(_components.code,{children:`500`}),` “Failed to generate skill test questions”.`]})}),`\n`,_jsx(ParamField,{body:`customQuestions`,type:`object[]`,id:`param-custom-questions`,children:_jsx(_components.p,{children:`Candidate-specific custom questions to attach to the interview.`})}),`\n`,_jsx(ParamField,{body:`additionalFields`,type:`object`,id:`param-additional-fields`,children:_jsx(_components.p,{children:`Custom Candidate fields configured in InterviewFlowAI.`})}),`\n`,_jsx(ParamField,{body:`metadata`,type:`object`,id:`param-metadata`,children:_jsxs(_components.p,{children:[`External reference data such as ATS IDs. `,_jsx(_components.code,{children:`metadata.phoneNumber`}),` sets the Candidate’s phone number.`]})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`12`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.interviewflowai.com/api/external/ingest/candidate\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-KEY: your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Jane Doe\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"email\": \"jane.doe@example.com\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"jobId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"status\": \"shortlisted\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"metadata\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"externalCandidateId\": \"candidate_12345\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`201`,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"jobId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane Doe\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"jane.doe@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"shortlisted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-07-01T10:30:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"interviewLink\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://app.interviewflowai.com/form?interviewId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`201`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Interview link created successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`behavior`,children:`Behavior`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Scenario`}),_jsx(_components.th,{children:`Behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Candidate already has an interview for the same Interviewer`}),_jsx(_components.td,{children:`The request is rejected and no new interview is created.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`jobId`}),` doesn’t exist or belongs to another Company`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`404`}),` “Job not found or does not belong to this account”.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Interviewer is archived`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`400`}),` “Cannot create interviews for archived jobs”.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`shortlisted`})]}),_jsx(_components.td,{children:`The returned link takes the candidate directly to the interview flow.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`draft`})]}),_jsx(_components.td,{children:`The interview is created as a draft candidate record.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Interviewer is public and `,_jsx(_components.code,{children:`status`}),` is omitted`]}),_jsxs(_components.td,{children:[`The interview is created as `,_jsx(_components.code,{children:`shortlisted`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Interviewer is private and `,_jsx(_components.code,{children:`status`}),` is omitted`]}),_jsxs(_components.td,{children:[`The interview is created as `,_jsx(_components.code,{children:`draft`}),`.`]})]})]})]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Use this endpoint when your ATS, CRM, or internal system also needs the interview link, for example to store it on the candidate record.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Invite a Candidate","description":"Invite one Candidate and get their interview link.","api":"POST /api/external/ingest/candidate","href":"/api-reference/candidates/invite"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Request body fields","slug":"request-body-fields","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Behavior","slug":"behavior","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"12\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.interviewflowai.com/api/external/ingest/candidate\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-API-KEY: your_api_key_here\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"name\": \"Jane Doe\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"email\": \"jane.doe@example.com\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"jobId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"status\": \"shortlisted\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"metadata\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"externalCandidateId\": \"candidate_12345\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"201","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"13\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"jobId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Jane Doe\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"email\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"jane.doe@example.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"shortlisted\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"createdAt\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-07-01T10:30:00.000Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"interviewLink\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://app.interviewflowai.com/form?interviewId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">201\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Interview link created successfully\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Invite a Candidate","path":"/api/external/ingest/candidate","servers":[{"url":"https://api.interviewflowai.com"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-API-KEY":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"name":[{"type":"string","description":"Candidate’s full name. Maximum 255 characters. Blank names are rejected.","required":true}],"email":[{"type":"string","description":"Candidate’s email address. The value is normalized to lowercase.","required":true}],"jobId":[{"type":"string","description":"The UUID of the Interviewer to create the interview under. Archived Interviewers are rejected.","required":true}],"status":[{"type":"string","description":"`shortlisted` or `draft` . If omitted, public Interviewers default to `shortlisted` and private Interviewers default to `draft` ."}],"resumeUrl":[{"type":"string","description":"A publicly accessible URL to the Candidate’s resume (PDF). InterviewFlowAI downloads the file and stores it as a PDF. If the download fails, the interview is still created, without a resume, and no error is returned."}],"skills":[{"type":"array","items":[{"type":"string"}],"description":"Skill names used to generate skill-based custom interview questions. If generation fails, the request returns `500` “Failed to generate skill test questions”."}],"customQuestions":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Candidate-specific custom questions to attach to the interview."}],"additionalFields":[{"type":"object","properties":{},"description":"Custom Candidate fields configured in InterviewFlowAI."}],"metadata":[{"type":"object","properties":{},"description":"External reference data such as ATS IDs. `metadata.phoneNumber` sets the Candidate’s phone number."}]}}],"examples":{"example":{"value":{"name":"\u003cstring>","email":"\u003cstring>","jobId":"\u003cstring>","status":"\u003cstring>","resumeUrl":"\u003cstring>","skills":["\u003cstring>"],"customQuestions":[{}],"additionalFields":{},"metadata":{}}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"interviewflowai","siteName":"InterviewFlowAI Knowledge Base","title":"Invite a Candidate - InterviewFlowAI Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T17:18:06.990Z","originalFileLocation":"api-reference/candidates/invite.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=\"Invite one Candidate and get their interview link.\">\u003cmeta data-mint-head name=\"application-name\" content=\"InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Invite a Candidate - InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Invite one Candidate and get their interview link.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.interviewflowai.com/api-reference/candidates/invite\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://interviewflowai.mintlify.site/_mintlify/api/og/v2?division=Candidates\u0026amp;title=Invite+a+Candidate\u0026amp;description=Invite+one+Candidate+and+get+their+interview+link.\u0026amp;theme=529d83cbab2ef6e2d0e572c0\u0026amp;signature=4d6a685c5816f39ed2740ae572de151ac7985c83a3d6819cbd57dcf5ed37f4e2\">\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=\"Invite a Candidate - InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Invite one Candidate and get their interview link.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://interviewflowai.mintlify.site/_mintlify/api/og/v2?division=Candidates\u0026amp;title=Invite+a+Candidate\u0026amp;description=Invite+one+Candidate+and+get+their+interview+link.\u0026amp;theme=529d83cbab2ef6e2d0e572c0\u0026amp;signature=4d6a685c5816f39ed2740ae572de151ac7985c83a3d6819cbd57dcf5ed37f4e2\">\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/interviewflowai/fm_oLBQTYOxe_7Ed/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B50D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.interviewflowai.com/api-reference/candidates/invite\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/candidates/invite.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.interviewflowai.com/#organization\",\"name\":\"InterviewFlowAI Knowledge Base\",\"url\":\"https://docs.interviewflowai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/interviewflowai/3Gmnw_L8IR0faXhJ/logo/logo.png?fit=max\u0026auto=format\u0026n=3Gmnw_L8IR0faXhJ\u0026q=85\u0026s=2eefa6ed5f15b3b9fe696130b4e91d1a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.interviewflowai.com#website\",\"name\":\"InterviewFlowAI Knowledge Base\",\"url\":\"https://docs.interviewflowai.com\",\"publisher\":{\"@id\":\"https://docs.interviewflowai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/invite#webpage\",\"url\":\"https://docs.interviewflowai.com/api-reference/candidates/invite\",\"name\":\"Invite a Candidate\",\"description\":\"Invite one Candidate and get their interview link.\",\"dateModified\":\"2026-11-15T17:18:06.990Z\",\"isPartOf\":{\"@id\":\"https://docs.interviewflowai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/invite#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/invite#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"InterviewFlowAI Knowledge Base\",\"item\":\"https://docs.interviewflowai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invite a Candidate\",\"item\":\"https://docs.interviewflowai.com/api-reference/candidates/invite\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/invite#apireference\",\"headline\":\"Invite a Candidate\",\"name\":\"Invite a Candidate\",\"description\":\"Invite one Candidate and get their interview link.\",\"url\":\"https://docs.interviewflowai.com/api-reference/candidates/invite\",\"mainEntityOfPage\":{\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/invite#webpage\"},\"dateModified\":\"2026-11-15T17:18:06.990Z\",\"publisher\":{\"@id\":\"https://docs.interviewflowai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.interviewflowai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"InterviewFlowAI Knowledge Base\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"InterviewFlowAI Knowledge Base\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/candidates/invite.md","siteName":"InterviewFlowAI Knowledge Base","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://interviewflowai.com/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"ATS \u0026 Integrations","pages":[{"title":"ATS \u0026 Integrations","href":"/platform/integrations"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API overview","icon":"code","href":"/api-reference/introduction"}]},{"group":"Developer setup","pages":[{"title":"API keys","icon":"key","href":"/platform/api-keys"},{"title":"Connect an AI assistant","icon":"server","href":"/platform/mcp"},{"title":"Webhooks","icon":"webhook","href":"/platform/webhooks"},{"title":"Custom integrations","icon":"code","href":"/platform/api-integration/overview"}]},{"group":"Interviewers","pages":[{"title":"Create an Interviewer","api":"POST /api/external/ingest/job","href":"/api-reference/interviewers/create"},{"title":"Update an Interviewer","description":"Change only the Interviewer settings you send.","api":"PUT /api/external/ingest/job/{jobId}","href":"/api-reference/interviewers/update"}]},{"group":"Candidates","pages":[{"title":"Invite a Candidate","api":"POST /api/external/ingest/candidate","href":"/api-reference/candidates/invite"},{"title":"Invite Candidates in bulk","description":"Invite up to 50 Candidates to one Interviewer in one request.","api":"POST /api/external/ingest/interview","href":"/api-reference/candidates/invite-bulk"},{"title":"List Candidates","api":"POST /api/external/fetch/candidates","href":"/api-reference/candidates/list"},{"title":"Update a Candidate","api":"PUT /api/external/interview","href":"/api-reference/candidates/update"},{"title":"Update custom fields","api":"PATCH /api/external/custom-fields","href":"/api-reference/candidates/update-custom-fields"}]},{"group":"Requests we send you","pages":[{"title":"Webhook events","icon":"webhook","href":"/api-reference/webhook-events"}]}]}]},"basePath":"","title":"Invite a Candidate - InterviewFlowAI Knowledge Base","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js"]}