Use the Edit Interview API to update a Candidate’s interview from your own system, for example to rename the Candidate, move them to a custom stage, or add notes.
Rate limit: 60 requests per minute per API key. Requests over the limit return 429 Too Many Requests.
Request body fields
string
required
The UUID of the interview to update.
string
The Candidate’s name. Must contain 1–255 characters.
string
The Candidate’s email address. At least 5 characters, no spaces. Stored in lowercase.
number
New invitation expiry time, as a Unix timestamp in milliseconds.
string
new or viewed.
string
A stage configured in your Company’s Custom Stages settings. 1–80 characters.
object[]
Replacement custom interview questions. Each item requires question. evaluationCriteria is optional; when you include it, lookingFor, strongAnswer, weakAnswer, weight (1–10) and maxFollowup (0–2) are required.
object
Replacement values for configured Candidate additional fields.
string
Internal notes, up to 5,000 characters.
At least one optional field should be included. Sending a status that is not configured as a custom stage returns 400 Bad Request with “Only stages in your hiring pipeline can be selected for status updates”.
The API key must belong to the same Company as the interview. A missing interview or an interview owned by another Company returns 404 Not Found.
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/update","slug":"/api-reference/candidates/update","pageMetadata":{"title":"Update a Candidate","description":"Rename a Candidate, move their stage, or add notes.","api":"PUT /api/external/interview","href":"/api-reference/candidates/update"},"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: \"Rename a Candidate, move their stage, or add notes.\"\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`,..._provideComponents(),...props.components},{Heading,Note,ParamField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the Edit Interview API to update a Candidate’s interview from your own system, for example to rename the Candidate, move them to a custom stage, or add notes.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 60 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:`interviewId`,type:`string`,required:true,id:`param-interview-id`,children:_jsx(_components.p,{children:`The UUID of the interview to update.`})}),`\n`,_jsx(ParamField,{body:`candidateName`,type:`string`,id:`param-candidate-name`,children:_jsx(_components.p,{children:`The Candidate’s name. Must contain 1–255 characters.`})}),`\n`,_jsx(ParamField,{body:`candidateEmail`,type:`string`,id:`param-candidate-email`,children:_jsx(_components.p,{children:`The Candidate’s email address. At least 5 characters, no spaces. Stored in lowercase.`})}),`\n`,_jsx(ParamField,{body:`expiryDateInMillis`,type:`number`,id:`param-expiry-date-in-millis`,children:_jsx(_components.p,{children:`New invitation expiry time, as a Unix timestamp in milliseconds.`})}),`\n`,_jsx(ParamField,{body:`viewStatus`,type:`string`,id:`param-view-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`new`}),` or `,_jsx(_components.code,{children:`viewed`}),`.`]})}),`\n`,_jsx(ParamField,{body:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`A stage configured in your Company’s `,_jsx(_components.strong,{children:`Custom Stages`}),` settings. 1–80 characters.`]})}),`\n`,_jsx(ParamField,{body:`customQuestions`,type:`object[]`,id:`param-custom-questions`,children:_jsxs(_components.p,{children:[`Replacement custom interview questions. Each item requires `,_jsx(_components.code,{children:`question`}),`. `,_jsx(_components.code,{children:`evaluationCriteria`}),` is optional; when you include it, `,_jsx(_components.code,{children:`lookingFor`}),`, `,_jsx(_components.code,{children:`strongAnswer`}),`, `,_jsx(_components.code,{children:`weakAnswer`}),`, `,_jsx(_components.code,{children:`weight`}),` (1–10) and `,_jsx(_components.code,{children:`maxFollowup`}),` (0–2) are required.`]})}),`\n`,_jsx(ParamField,{body:`candidateAdditionalFields`,type:`object`,id:`param-candidate-additional-fields`,children:_jsx(_components.p,{children:`Replacement values for configured Candidate additional fields.`})}),`\n`,_jsx(ParamField,{body:`recruiterNotes`,type:`string`,id:`param-recruiter-notes`,children:_jsx(_components.p,{children:`Internal notes, up to 5,000 characters.`})}),`\n`,_jsxs(_components.p,{children:[`At least one optional field should be included. Sending a `,_jsx(_components.code,{children:`status`}),` that is not configured as a custom stage returns `,_jsx(_components.code,{children:`400 Bad Request`}),` with “Only stages in your hiring pipeline can be selected for status updates”.`]}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,`\n`,_jsxs(_components.p,{children:[`The API key must belong to the same Company as the interview. A missing interview or an interview owned by another Company returns `,_jsx(_components.code,{children:`404 Not Found`}),`.`]})]})}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":"Update a Candidate","description":"Rename a Candidate, move their stage, or add notes.","api":"PUT /api/external/interview","href":"/api-reference/candidates/update"}}},"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`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample}=_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);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the Edit Interview API to update a Candidate’s interview from your own system, for example to rename the Candidate, move them to a custom stage, or add notes.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 60 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:`interviewId`,type:`string`,required:true,id:`param-interview-id`,children:_jsx(_components.p,{children:`The UUID of the interview to update.`})}),`\n`,_jsx(ParamField,{body:`candidateName`,type:`string`,id:`param-candidate-name`,children:_jsx(_components.p,{children:`The Candidate’s name. Must contain 1–255 characters.`})}),`\n`,_jsx(ParamField,{body:`candidateEmail`,type:`string`,id:`param-candidate-email`,children:_jsx(_components.p,{children:`The Candidate’s email address. At least 5 characters, no spaces. Stored in lowercase.`})}),`\n`,_jsx(ParamField,{body:`expiryDateInMillis`,type:`number`,id:`param-expiry-date-in-millis`,children:_jsx(_components.p,{children:`New invitation expiry time, as a Unix timestamp in milliseconds.`})}),`\n`,_jsx(ParamField,{body:`viewStatus`,type:`string`,id:`param-view-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`new`}),` or `,_jsx(_components.code,{children:`viewed`}),`.`]})}),`\n`,_jsx(ParamField,{body:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`A stage configured in your Company’s `,_jsx(_components.strong,{children:`Custom Stages`}),` settings. 1–80 characters.`]})}),`\n`,_jsx(ParamField,{body:`customQuestions`,type:`object[]`,id:`param-custom-questions`,children:_jsxs(_components.p,{children:[`Replacement custom interview questions. Each item requires `,_jsx(_components.code,{children:`question`}),`. `,_jsx(_components.code,{children:`evaluationCriteria`}),` is optional; when you include it, `,_jsx(_components.code,{children:`lookingFor`}),`, `,_jsx(_components.code,{children:`strongAnswer`}),`, `,_jsx(_components.code,{children:`weakAnswer`}),`, `,_jsx(_components.code,{children:`weight`}),` (1–10) and `,_jsx(_components.code,{children:`maxFollowup`}),` (0–2) are required.`]})}),`\n`,_jsx(ParamField,{body:`candidateAdditionalFields`,type:`object`,id:`param-candidate-additional-fields`,children:_jsx(_components.p,{children:`Replacement values for configured Candidate additional fields.`})}),`\n`,_jsx(ParamField,{body:`recruiterNotes`,type:`string`,id:`param-recruiter-notes`,children:_jsx(_components.p,{children:`Internal notes, up to 5,000 characters.`})}),`\n`,_jsxs(_components.p,{children:[`At least one optional field should be included. Sending a `,_jsx(_components.code,{children:`status`}),` that is not configured as a custom stage returns `,_jsx(_components.code,{children:`400 Bad Request`}),` with “Only stages in your hiring pipeline can be selected for status updates”.`]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`9`,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:`9`,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:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.interviewflowai.com/api/external/interview\"`}),_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:` \"interviewId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"candidateName\": \"Taylor Morgan\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"status\": \"Technical Review\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"recruiterNotes\": \"Strong systems design experience.\"`})}),`\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:`200`,numberOfLines:`4`,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:`4`,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:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_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 updated successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`The API key must belong to the same Company as the interview. A missing interview or an interview owned by another Company returns `,_jsx(_components.code,{children:`404 Not Found`}),`.`]})]})}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":"Update a Candidate","description":"Rename a Candidate, move their stage, or add notes.","api":"PUT /api/external/interview","href":"/api-reference/candidates/update"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Request body fields","slug":"request-body-fields","depth":2,"children":[]},{"title":"Response","slug":"response","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=\"9\">\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\"> PUT\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.interviewflowai.com/api/external/interview\"\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\"> \"interviewId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"candidateName\": \"Taylor Morgan\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"status\": \"Technical Review\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"recruiterNotes\": \"Strong systems design experience.\"\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":"200","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=\"4\">\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\">200\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 updated 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":"Update a Candidate","path":"/api/external/interview","servers":[{"url":"https://api.interviewflowai.com"}],"method":"put","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":{"interviewId":[{"type":"string","description":"The UUID of the interview to update.","required":true}],"candidateName":[{"type":"string","description":"The Candidate’s name. Must contain 1–255 characters."}],"candidateEmail":[{"type":"string","description":"The Candidate’s email address. At least 5 characters, no spaces. Stored in lowercase."}],"expiryDateInMillis":[{"type":"number","description":"New invitation expiry time, as a Unix timestamp in milliseconds."}],"viewStatus":[{"type":"string","description":"`new` or `viewed` ."}],"status":[{"type":"string","description":"A stage configured in your Company’s Custom Stages settings. 1–80 characters."}],"customQuestions":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Replacement custom interview questions. Each item requires `question` . `evaluationCriteria` is optional; when you include it, `lookingFor` , `strongAnswer` , `weakAnswer` , `weight` (1–10) and `maxFollowup` (0–2) are required."}],"candidateAdditionalFields":[{"type":"object","properties":{},"description":"Replacement values for configured Candidate additional fields."}],"recruiterNotes":[{"type":"string","description":"Internal notes, up to 5,000 characters."}]}}],"examples":{"example":{"value":{"interviewId":"\u003cstring>","candidateName":"\u003cstring>","candidateEmail":"\u003cstring>","expiryDateInMillis":123,"viewStatus":"\u003cstring>","status":"\u003cstring>","customQuestions":[{}],"candidateAdditionalFields":{},"recruiterNotes":"\u003cstring>"}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"interviewflowai","siteName":"InterviewFlowAI Knowledge Base","title":"Update a Candidate - InterviewFlowAI Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T17:18:06.990Z","originalFileLocation":"api-reference/candidates/update.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=\"Rename a Candidate, move their stage, or add notes.\">\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=\"Update a Candidate - InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Rename a Candidate, move their stage, or add notes.\">\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/update\">\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=Update+a+Candidate\u0026amp;description=Rename+a+Candidate%2C+move+their+stage%2C+or+add+notes.\u0026amp;theme=529d83cbab2ef6e2d0e572c0\u0026amp;signature=1b0cfb39dbcea6be3964d6d3b6e71499fedf5cb8f00b81dec9aef02841c2a26c\">\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=\"Update a Candidate - InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Rename a Candidate, move their stage, or add notes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://interviewflowai.mintlify.site/_mintlify/api/og/v2?division=Candidates\u0026amp;title=Update+a+Candidate\u0026amp;description=Rename+a+Candidate%2C+move+their+stage%2C+or+add+notes.\u0026amp;theme=529d83cbab2ef6e2d0e572c0\u0026amp;signature=1b0cfb39dbcea6be3964d6d3b6e71499fedf5cb8f00b81dec9aef02841c2a26c\">\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/update\">\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/update.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/update#webpage\",\"url\":\"https://docs.interviewflowai.com/api-reference/candidates/update\",\"name\":\"Update a Candidate\",\"description\":\"Rename a Candidate, move their stage, or add notes.\",\"dateModified\":\"2026-11-15T17:18:06.990Z\",\"isPartOf\":{\"@id\":\"https://docs.interviewflowai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Candidates\",\"item\":\"https://docs.interviewflowai.com/api-reference/candidates/invite\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a Candidate\",\"item\":\"https://docs.interviewflowai.com/api-reference/candidates/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/update#apireference\",\"headline\":\"Update a Candidate\",\"name\":\"Update a Candidate\",\"description\":\"Rename a Candidate, move their stage, or add notes.\",\"url\":\"https://docs.interviewflowai.com/api-reference/candidates/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.interviewflowai.com/api-reference/candidates/update#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/update.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","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","api":"POST /api/external/ingest/interview","href":"/api-reference/candidates/invite-bulk"},{"title":"List Candidates","description":"Fetch Candidates, their interviews and results, with filters.","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","description":"Sync scores and flags from your tools into a Candidate's additional 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":"Update 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"]}