{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
Interviews
Update an interview or position
Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send questions; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and questions_diff in the response for what was decided. Questions of an interview that is already active can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to draft first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. mojito_language_code cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring team; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
Authorizations
Authorization
string
header
required
Supabase JWT — Authorization: Bearer <token>.
Body
application/json
position_id
string<uuid>
required
Id of the interview definition (single-stage) or position definition (multi-stage) to update. The same id you pass to job-interview-get.
Minimum string length: 1
Example:
"00000000-0000-0000-0000-000000000000"
status
enum<string>
New publication status (preparing and completed are normally set by the platform), applied exactly as job-interview-set-state applies it: archiving an active position e-mails its candidates with open applications when the position-closed notice is on (job-interview-set-state previews that with dry_run, and also manages the iframe embed key and the vacancy lifecycle of a position). Refused (422) for the AI interview step of a multi-stage position: its status follows the position.
Available options:
draft,
active,
archived,
deleted,
preparing,
completed
Example:
"active"
visibility
enum<string>
Who can discover and access the interview. Refused (422) for the AI interview step of a multi-stage position: it follows the position. Options — merchant_public: Listed on the merchant's public interview list — anyone with the merchant link can find and start it. | merchant_invite: Invite-only — only candidates explicitly invited (by email/link) can access it; not listed anywhere. | merchant_unlisted: Reachable only via a direct link — not listed anywhere; share the link manually.
Available options:
merchant_public,
merchant_invite,
merchant_unlisted
Example:
"merchant_public"
environment
enum<string>
Which of your webhook environments results from this interview are delivered to. Defaults to production. Options — production: Live hiring. Results reach the webhooks configured as production. This is the default when the field is omitted. | uat: User-acceptance testing - an isolated environment for pre-release verification. | development: Development/testing. Use for interviews created by a test or preview app so their results never reach the production webhook. | demo: Demonstrations and sales trials.
Department the position belongs to. Blank is stored as null.
Example:
"Engineering"
interview_salary
string | null
Salary range shown for the position. Blank is stored as null.
Example:
"$80k - $100k"
interview_available_till
string | null
ISO date/time after which the interview is no longer available to candidates. null keeps it always available.
Example:
"2026-12-31"
recruiter_profile_id
string | null
Profile id of the recruiter owning this interview or position (profile.id). Must be an active owner, recruiter or admin of the company (own staff or a sub-merchant grant holder), else 422. null clears it.
candidate_notification_channel
enum<string> | null
SMS / WhatsApp notifications to the candidate, sent alongside the e-mails: "reminders" = with both e-mail reminders (day 1 and day 3); "last_reminder" = only with the final day-3 reminder; "all" = invitation, both reminders and the pre-screening-accepted step. null switches them off. WhatsApp is tried first, SMS when the number is not on WhatsApp. Available on paid plans (Starter and above) and needs a phone number on the candidate.
Available options:
reminders,
last_reminder,
all
country_availability
object | null
Which countries the interview / position is open to on the candidate portal, judged by the IP address the candidate opens it from (an unknown location only passes when countries_allowed / countries_allowed_eu are empty). From a closed country it is left out of the portal listings, and a direct link shows "not available in your region". Invited candidates (personal invitation links) and candidates who already started keep access; API and MCP calls themselves are never restricted. Null = not used, every country.
Show child attributes
tags
string[] | null
Free-form tags stored on the interview. Tags are also the coaching-catalogue mapping key: a catalogue directory (see the catalogue-tag-create / catalogue-tag-update endpoints) lists a coaching or persona session when the session's tags contain EVERY tag in that directory's tags_interview_set_filter. Only active sessions with visibility merchant_public (or the platform's own public) are listed.
Example:
["interview-practice", "sales"]
interview_category
string | null
Job category shown on public listings above the department (free text), e.g. "Ashore". Interviews and positions. Blank is stored as null.
Example:
"Ashore"
emoji
string | null
Emoji marker shown in the admin lists. Interviews and positions. Blank is stored as null.
collect_resume_cover_letter
enum<string>
Ask the candidate for a resume / cover letter: hidden, optional or required. Single-stage interviews only.
Available options:
hidden,
optional,
required
allow_human_interview
boolean
A recruiter may hold the interview instead of the AI. Single-stage interviews only (an interview step of a position carries its own setting, see merchant-position-step-update).
team
object[]
Multi-stage positions only (422 on an interview): the complete hiring team you want, replacing the current members (viewers, managed with position access, are kept). An empty array removes everyone. Needs the hiring team switched on for the company (else 403) and access to the position. Each member is a person (profile_id: an active or invited staff user of the company) or a group (profile_group_id), with a role. The answer carries the resulting team.
Company-defined position fields to set, {key: value}; a null value clears that field and keys you omit keep their value. Values are checked against the field definitions (option values, YYYY-MM-DD dates, {min, max, currency} ranges, user profile ids). Requires custom fields to be enabled for the company (else 403). Multi-stage positions only: on a single-stage interview the request is refused with 422.
OPTIONAL. Omit this field entirely and the interview's questions are left exactly as they are — questions are only touched when you send the array. When you do send it, send the COMPLETE list you want the interview to end up with, in order, in the same format job-interview-create-from-array accepts and job-interview-get returns: there is no way to change a single question on its own, so read the interview, edit that array, and send the whole thing back. An empty array is rejected. It is applied as a DIFF, not a replace, so resending the array job-interview-get gave you changes nothing at all. Each entry is matched against what is stored — first on external_id, then on id, then on identical content — and: an entry matching an unchanged question keeps that question exactly as it is, including its answer rules and any rendered avatar video; an entry matching a question whose content differs unlinks the old question and creates a new one in its place (fields you omit are carried over from the old one); an entry matching nothing is created; and a stored question no entry matches is unlinked. questions_diff in the response reports exactly what was decided. Questions are shared records, so nothing is ever deleted — removing one only unlinks it from this interview, and an edit is always unlink-old + create-new so the change cannot leak into another interview reusing the same question. The welcome, thank-you and instructional-video steps are not part of this array and are left in place. Single-stage interviews only; for a multi-stage position, update its interview stages individually.
Minimum array length: 1
Show child attributes
regenerate_candidate_expectations
boolean
Re-derive the interview-level candidate_expectations_json scoring rubric from the resulting question list, the way job-interview-create-from-array derives it at creation time. Only applies when questions is sent, the interview type is interview, and candidate_expectations_json is not also being set explicitly (an explicit value wins).
Example:
false
type
enum<string>
Product type of the interview. Changing it also re-derives type_credit (null for interview/assessment, otherwise interview_coach_manager) unless you send type_credit explicitly. Single-stage interviews only.
Available options:
interview,
coaching,
assessment
Example:
"interview"
type_credit
enum<string> | null
Credit bucket the session draws from. Only meaningful for candidate-paid coaching/persona sessions; hiring interviews and assessments are merchant-billed and carry null. Options — resume_check: Resume Builder credits. | interview_coach_starter: Coaching credits — starter tier. | interview_coach_contributor: Coaching credits — contributor tier. | interview_coach_manager: Coaching credits — manager tier. | cover_letter: Cover-letter credits.
Available options:
resume_check,
interview_coach_starter,
interview_coach_contributor,
interview_coach_manager,
cover_letter
Example:
"interview_coach_manager"
coach_plan
enum<string> | null
Coaching-plan stage this item belongs to, used by the coaching-plan progress view. Omit/null to leave it out of any plan. Options — demo: Demo session. | screening: Screening-interview practice. | 2nd: Second-interview practice. | 3rd: Third-interview practice. | closing: Closing / salary-negotiation practice. | job-specific: Job-specific coaching. | other: Anything that does not fit the other buckets.
Available options:
demo,
screening,
2nd,
3rd,
closing,
job-specific,
other
Example:
"screening"
interview_template_id
string
Id of the interview template (avatar/voice) to use. An id from merchant-avatar-list. Also decides the modality: see merchant-avatar-list.
Minimum string length: 1
Example:
"46b98d37-1557-4391-beca-03037ead19f2"
knowledge_base_store_id
string | null
Knowledge base store id the interview draws context from; validated for existence. null unlinks it.
recording
enum<string> | null
Cheating/proctoring detection mode for candidate answers — this is NOT a full session recording. Video options also record the candidate. Omit to keep the current mode; none switches it off (null does too). Options — audio_first_5_answers: Audio-only cheating detection, first 5 answers only. | audio_all: Audio-only cheating detection on every answer. | video_all: Audio + video cheating detection on every answer (candidate is recorded for all answers). | video_first_5_answers: Audio + video cheating detection, first 5 answers only. | none: Switch cheating detection off.
Available options:
audio_first_5_answers,
audio_all,
video_all,
video_first_5_answers,
none
Example:
"video_all"
recording_full_session
enum<string> | null
Full interview-session recording (includes the avatar and voice) produced as a single file. Independent of recording. Omit to keep the current setting; none switches it off (null does too). Options — audio_all: Record the whole session audio (avatar + candidate voice) into a single file. Adds +0.2 credits. | video_all: Record the whole session video + audio (avatar + candidate) into a single file. Adds +0.4 credits. | none: Switch the full-session recording off.
Available options:
audio_all,
video_all,
none
Example:
"video_all"
result_view
enum<string>
Result screen shown to the candidate after finishing. With any value other than none, the candidate sees a results screen where they can provide feedback, record an intro video and edit the transcript, and must then submit the result; the value sets how much score/result detail is shown. Options — none: No results screen at all — the interview is submitted immediately when the candidate finishes (no feedback, intro video, transcript edit or manual submit step). | minimal: Minimal results layout, no score shown. | minimal_with_score: Minimal results layout including the overall score. | advanced: Advanced results layout with more detail. | full: Full results layout with all sections. | full_expand_scores: Full results with every score breakdown expanded.
Available options:
none,
minimal,
minimal_with_score,
advanced,
full,
full_expand_scores
Example:
"full"
candidate_video_introduction
enum<string> | null
Whether a candidate video introduction is hidden, optional or required. null is treated like hidden.
Available options:
hidden,
optional,
required
interview_conversation_speed
enum<string> | null
Conversation pace of the AI avatar. Omit/null keeps the template default pace. Options — slower: The avatar speaks more slowly — easier to follow for non-native speakers. | normal: Default speaking pace. | faster: The avatar speaks more quickly for a snappier conversation. | fluent: Talking pace: the avatar answers 300 ms after the candidate stops speaking. A pause mid-sentence also ends their turn.
Available options:
slower,
normal,
faster,
fluent
Example:
"normal"
max_followups
integer | null
Maximum number of AI follow-up questions. 0 disables follow-ups; presets are 0-3 (none/low/normal/high) and custom values start at 4; null uses the template default (Normal).
Required range: 0 <= x <= 999
Example:
2
max_duration
number | null
Live session limit in seconds. Also the basis for the credit multiplier.
Example:
1200
questions_random_subset
number | null
Ask only a random subset of the questions, as a fraction between 0.01 and 0.9. null asks all questions.
Required range: 0.01 <= x <= 0.9
Example:
0.5
interview_attempts
number
Allowed candidate attempts (1-20). Stored as result_scoring.max_retries.
Required range: 1 <= x <= 20
Example:
1
required_pronunciation
boolean | null
Require pronunciation assessment (restricts to pronunciation-capable languages).
result_enable_edit_transcript
boolean | null
Allow editing the transcript on the result view.
candidate_expectations
string | null
Free-text candidate expectations.
candidate_expectations_json
object | null
Structured candidate expectations (the scoring rubric), bucketed by requirement level (weak/moderate/strong). null clears the rubric. Extra keys are preserved.
Show child attributes
custom_scoring
object | null
Result-scoring overrides (max_score, early_stop, speech_cadence, ai_pronunciation, sentiment_analysis, ai_assessment_answer, ai_assessment_resume, ai_assessment_session). Merged onto the stored configuration, so keys you omit keep their current value.
Show child attributes
pdf_export_auto_config
object | null
Auto-generate a candidate PDF report with these options once the interview completes. null disables auto-export.
Show child attributes
interview_type
enum<string> | null
Interview style — configures the AI avatar and the follow-up questions it generates during the interview. Stored in creation_parameters; existing questions are NOT regenerated. Options — pre-screening: Pre-screening — quick qualification check focusing on basic requirements and availability. | pre-screening-with-test-questions: Pre-screening with test questions — pre-screening plus practical questions to test relevant skills. | second-interview: Second round interview — deeper dive for candidates who passed initial screening. | remote-freelancer-verification: Remote worker verification — verify remote work capabilities and communication skills. | strength-based-interview: Strength-based interview — focus on what candidates enjoy and excel at to predict job satisfaction. | potential-based-interview: Potential-based interview — assess learning ability and growth potential rather than past experience. | process-verification-from-knowledge-base: Knowledge Base interview — generate questions from your knowledge base documents. | knockout-screening: Knock-out screening — a short (about 5 minute) check of the role's must-haves with closed questions; ends early, politely, when a must-have is clearly not met. On creation it defaults custom_scoring.early_stop to true (where the avatar supports early stop) and max_followups to 1 unless you send them.
Available options:
pre-screening,
pre-screening-with-test-questions,
second-interview,
remote-freelancer-verification,
strength-based-interview,
potential-based-interview,
process-verification-from-knowledge-base,
knockout-screening
Example:
"pre-screening-with-test-questions"
interview_tone
enum<string> | null
Tone — configures the AI avatar's speaking style and the follow-up questions it generates. Stored in creation_parameters; existing questions are NOT regenerated. Case-insensitive; omit to keep the current tone. Options — relaxed: Friendly and conversational tone that helps candidates feel at ease. | simple: Plain language at CEFR A2 level — short sentences and simple words. | professional: Formal and business-like approach suitable for senior roles. | persuasive: Engaging style that encourages candidates to elaborate. | exact: Asks the questions exactly as provided, without rephrasing — for interviews built from your own questions where the wording is a script.
Available options:
relaxed,
simple,
professional,
persuasive,
exact
Example:
"professional"
seniority_level
enum<string> | null
Target seniority level for the role; omit to keep the current one. Options — entry-level: Early-career or graduate roles. | intermediate: Some experience required. | senior: Experienced professional. | managerial: Team or department lead. | director: Director-level responsibility. | executive: C-suite or executive role.
Available options:
entry-level,
intermediate,
senior,
managerial,
director,
executive
Example:
"senior"
hiring_for_company
object | null
Who the position is really for. null (or an object with name null/blank) means hiring for yourself; { name: 'undisclosed' } for an unnamed external client; or { name: '' } plus optional description/location/sector/company_size. Stored in creation_parameters.hiring_for_company.
Show child attributes
Example:
{ "name": "undisclosed" }
Response
Interview / position updated.
Confirmation of what was updated.
position_id
string
required
The id that was updated.
is_multistage
boolean
required
True when the id resolved to a multi-stage position (position_def_set) rather than a single interview.
updated_fields
string[]
required
Names of the stored columns that were written, plus status when the publication status was changed, questions when the question list was diffed, custom_fields and team when those were set.
Example:
["name", "tags"]
questions_diff
object
What the question diff decided, question by question. Absent when questions was not sent.
Show child attributes
team
object
The hiring team after the change. Absent when team was not sent.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"JobMojito Developer / Agent","description":"AI Interview and assessment conversational platform documentation","colors":{"primary":"#639C42","light":"#ACCC37","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=6c00cb5f3104ffb6325dacc0818bba69","dark":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-dark.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=a05ab0ca109d7a225b08ccac00f9c486","href":"https://jobmojito.com"},"favicon":{"light":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/favicon-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=f300813ab120824238a790b6905dceee","dark":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/favicon-dark.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=2104ff9e7b9fd23fbe5954886c0aafbe"},"navbar":{"links":[{"href":"https://jobmojito.com/support","label":"Support"},{"href":"https://jobmojito.com","label":"Homepage"},{"href":"https://app.jobmojito.com","label":"App"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.mintlify.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/jobmojito"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"toc"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"jobmojito","hasAudioNarration":false,"actualSubdomain":"jobmojito","customDomains":["developer.jobmojito.com"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-jobmojito-fee23398","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af1dfb6ee06d45cdd87d014","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":82},{"language":"default","tag":"Admin","count":19},{"language":"default","tag":"Cookbooks","count":17},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"MCP","count":13},{"language":"default","tag":"Candidates","count":12},{"language":"default","tag":"Interviews","count":10},{"language":"default","tag":"Connect","count":8},{"language":"default","tag":"Reports","count":7},{"language":"default","tag":"Results","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/interviews/update-an-interview-or-position","slug":"/api-reference/interviews/update-an-interview-or-position","pageMetadata":{"title":"Update an interview or position","description":"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send `questions`; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and `questions_diff` in the response for what was decided. Questions of an interview that is already `active` can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to `draft` first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. `mojito_language_code` cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring `team`; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-update","href":"/api-reference/interviews/update-an-interview-or-position","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send \", _jsx(_components.code, {\n children: \"questions\"\n }), \"; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and \", _jsx(_components.code, {\n children: \"questions_diff\"\n }), \" in the response for what was decided. Questions of an interview that is already \", _jsx(_components.code, {\n children: \"active\"\n }), \" can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to \", _jsx(_components.code, {\n children: \"draft\"\n }), \" first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. \", _jsx(_components.code, {\n children: \"mojito_language_code\"\n }), \" cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring \", _jsx(_components.code, {\n children: \"team\"\n }), \"; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).\"]\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":"Update an interview or position","description":"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send `questions`; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and `questions_diff` in the response for what was decided. Questions of an interview that is already `active` can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to `draft` first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. `mojito_language_code` cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring `team`; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-update","href":"/api-reference/interviews/update-an-interview-or-position","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Interviews"],"summary":"Update an interview or position","description":"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send `questions`; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and `questions_diff` in the response for what was decided. Questions of an interview that is already `active` can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to `draft` first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. `mojito_language_code` cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring `team`; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).","security":["b373de9d-d42d-4695-8805-97206683ce3a"],"requestBody":"c4595094-43b1-4b5f-abea-54ee73b50a0c","responses":{"200":"c7c4e772-f10b-48e6-bd79-8ea2e0cf1943","401":"6eededef-494b-4141-b95e-3118582fed9e","403":"6a5c811a-aa2d-4214-a193-73c2bfce9232","404":"a9a75482-7470-4f30-8541-a502a1c94f3c","409":"2fa2ecc5-c5b4-4dbb-b046-daffa7fc7dff","422":"15758c9e-0b8f-48ed-9483-a3bea2e95e4d","500":"38eda7a1-161f-4360-86e1-d6b07270c1bb"},"method":"post","type":"path","servers":["454fcb62-7052-4847-a728-ecf5ade065a6"],"path":"/job-interview-update","baseUrlOptions":["https://cool.jobmojito.com/functions/v1"],"title":"Update an interview or position","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"position_id":{"type":"string","minLength":1,"format":"uuid","description":"Id of the interview definition (single-stage) or position definition (multi-stage) to update. The same id you pass to job-interview-get.","example":"00000000-0000-0000-0000-000000000000","isRequired":true,"uniqueKey":"position_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["draft","active","archived","deleted","preparing","completed"],"description":"New publication status (preparing and completed are normally set by the platform), applied exactly as job-interview-set-state applies it: archiving an active position e-mails its candidates with open applications when the position-closed notice is on (job-interview-set-state previews that with dry_run, and also manages the iframe embed key and the vacancy lifecycle of a position). Refused (422) for the AI interview step of a multi-stage position: its status follows the position.","example":"active","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"visibility":{"type":"string","enum":["merchant_public","merchant_invite","merchant_unlisted"],"description":"Who can discover and access the interview. Refused (422) for the AI interview step of a multi-stage position: it follows the position. Options — `merchant_public`: Listed on the merchant's public interview list — anyone with the merchant link can find and start it. | `merchant_invite`: Invite-only — only candidates explicitly invited (by email/link) can access it; not listed anywhere. | `merchant_unlisted`: Reachable only via a direct link — not listed anywhere; share the link manually.","example":"merchant_public","uniqueKey":"visibility","typeLabel":"enum\u003cstring>"},"environment":{"type":"string","enum":["production","uat","development","demo"],"description":"Which of your webhook environments results from this interview are delivered to. Defaults to production. Options — `production`: Live hiring. Results reach the webhooks configured as production. This is the default when the field is omitted. | `uat`: User-acceptance testing - an isolated environment for pre-release verification. | `development`: Development/testing. Use for interviews created by a test or preview app so their results never reach the production webhook. | `demo`: Demonstrations and sales trials.","example":"production","uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","description":"Interview / position name.","example":"Project manager","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Interview / position name.","example":"Project manager","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"External code/reference. Blank is stored as null.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"External code/reference. Blank is stored as null.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"location":{"oneOf":[{"type":"string","description":"Interview location. Blank is stored as null.","example":"remote","uniqueKey":"location.oneOf.0","typeLabel":"string"},{"type":"null","description":"Interview location. Blank is stored as null.","example":"remote","uniqueKey":"location.oneOf.1","typeLabel":"null"}],"uniqueKey":"location","typeLabel":"string | null"},"cover_image_url":{"oneOf":[{"type":"string","description":"Cover image URL.","uniqueKey":"cover_image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cover image URL.","uniqueKey":"cover_image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cover_image_url","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Short interview description.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Short interview description.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"description_long":{"oneOf":[{"type":"string","description":"Long-form interview description. Rendered as Markdown on the candidate-facing position page, including chips, callouts, cards, columns and buttons — formatting guide: https://developer.jobmojito.com/cookbooks/format-content-with-markdown","uniqueKey":"description_long.oneOf.0","typeLabel":"string"},{"type":"null","description":"Long-form interview description. Rendered as Markdown on the candidate-facing position page, including chips, callouts, cards, columns and buttons — formatting guide: https://developer.jobmojito.com/cookbooks/format-content-with-markdown","uniqueKey":"description_long.oneOf.1","typeLabel":"null"}],"uniqueKey":"description_long","typeLabel":"string | null"},"interview_department":{"oneOf":[{"type":"string","description":"Department the position belongs to. Blank is stored as null.","example":"Engineering","uniqueKey":"interview_department.oneOf.0","typeLabel":"string"},{"type":"null","description":"Department the position belongs to. Blank is stored as null.","example":"Engineering","uniqueKey":"interview_department.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_department","typeLabel":"string | null"},"interview_salary":{"oneOf":[{"type":"string","description":"Salary range shown for the position. Blank is stored as null.","example":"$80k - $100k","uniqueKey":"interview_salary.oneOf.0","typeLabel":"string"},{"type":"null","description":"Salary range shown for the position. Blank is stored as null.","example":"$80k - $100k","uniqueKey":"interview_salary.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_salary","typeLabel":"string | null"},"interview_available_till":{"oneOf":[{"type":"string","description":"ISO date/time after which the interview is no longer available to candidates. null keeps it always available.","example":"2026-12-31","uniqueKey":"interview_available_till.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO date/time after which the interview is no longer available to candidates. null keeps it always available.","example":"2026-12-31","uniqueKey":"interview_available_till.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_available_till","typeLabel":"string | null"},"recruiter_profile_id":{"oneOf":[{"type":"string","description":"Profile id of the recruiter owning this interview or position (profile.id). Must be an active owner, recruiter or admin of the company (own staff or a sub-merchant grant holder), else 422. null clears it.","uniqueKey":"recruiter_profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Profile id of the recruiter owning this interview or position (profile.id). Must be an active owner, recruiter or admin of the company (own staff or a sub-merchant grant holder), else 422. null clears it.","uniqueKey":"recruiter_profile_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"recruiter_profile_id","typeLabel":"string | null"},"candidate_notification_channel":{"oneOf":[{"type":"string","enum":["reminders","last_reminder","all"],"description":"SMS / WhatsApp notifications to the candidate, sent alongside the e-mails: \"reminders\" = with both e-mail reminders (day 1 and day 3); \"last_reminder\" = only with the final day-3 reminder; \"all\" = invitation, both reminders and the pre-screening-accepted step. null switches them off. WhatsApp is tried first, SMS when the number is not on WhatsApp. Available on paid plans (Starter and above) and needs a phone number on the candidate.","uniqueKey":"candidate_notification_channel.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["reminders","last_reminder","all"],"description":"SMS / WhatsApp notifications to the candidate, sent alongside the e-mails: \"reminders\" = with both e-mail reminders (day 1 and day 3); \"last_reminder\" = only with the final day-3 reminder; \"all\" = invitation, both reminders and the pre-screening-accepted step. null switches them off. WhatsApp is tried first, SMS when the number is not on WhatsApp. Available on paid plans (Starter and above) and needs a phone number on the candidate.","uniqueKey":"candidate_notification_channel.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidate_notification_channel","typeLabel":"enum\u003cstring> | null"},"country_availability":{"oneOf":[{"type":"object","properties":{"countries_allowed":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$","uniqueKey":"country_availability.oneOf.0.countries_allowed.items.[INDEX]","typeLabel":"string"},"description":"Available ONLY to candidates in these countries (ISO 3166-1 alpha-2).","example":["PH","IN"],"uniqueKey":"country_availability.oneOf.0.countries_allowed","typeLabel":"string[]"},"countries_allowed_eu":{"type":"boolean","description":"Adds every EU country (plus EEA and Switzerland) to countries_allowed.","uniqueKey":"country_availability.oneOf.0.countries_allowed_eu","typeLabel":"boolean"},"countries_blocked":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$","uniqueKey":"country_availability.oneOf.0.countries_blocked.items.[INDEX]","typeLabel":"string"},"description":"NOT available to candidates in these countries (ISO 3166-1 alpha-2). Wins over the allowed side.","example":["US"],"uniqueKey":"country_availability.oneOf.0.countries_blocked","typeLabel":"string[]"},"countries_blocked_eu":{"type":"boolean","description":"Adds every EU country (plus EEA and Switzerland) to countries_blocked.","uniqueKey":"country_availability.oneOf.0.countries_blocked_eu","typeLabel":"boolean"}},"description":"Which countries the interview / position is open to on the candidate portal, judged by the IP address the candidate opens it from (an unknown location only passes when countries_allowed / countries_allowed_eu are empty). From a closed country it is left out of the portal listings, and a direct link shows \"not available in your region\". Invited candidates (personal invitation links) and candidates who already started keep access; API and MCP calls themselves are never restricted. Null = not used, every country.","uniqueKey":"country_availability.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"countries_allowed":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"Available ONLY to candidates in these countries (ISO 3166-1 alpha-2).","example":["PH","IN"]},"countries_allowed_eu":{"type":"boolean","description":"Adds every EU country (plus EEA and Switzerland) to countries_allowed."},"countries_blocked":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"NOT available to candidates in these countries (ISO 3166-1 alpha-2). Wins over the allowed side.","example":["US"]},"countries_blocked_eu":{"type":"boolean","description":"Adds every EU country (plus EEA and Switzerland) to countries_blocked."}},"description":"Which countries the interview / position is open to on the candidate portal, judged by the IP address the candidate opens it from (an unknown location only passes when countries_allowed / countries_allowed_eu are empty). From a closed country it is left out of the portal listings, and a direct link shows \"not available in your region\". Invited candidates (personal invitation links) and candidates who already started keep access; API and MCP calls themselves are never restricted. Null = not used, every country.","uniqueKey":"country_availability.oneOf.1","typeLabel":"null"}],"uniqueKey":"country_availability","typeLabel":"object | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Free-form tags stored on the interview. Tags are also the coaching-catalogue mapping key: a catalogue directory (see the catalogue-tag-create / catalogue-tag-update endpoints) lists a coaching or persona session when the session's tags contain EVERY tag in that directory's `tags_interview_set_filter`. Only `active` sessions with visibility `merchant_public` (or the platform's own `public`) are listed.","example":["interview-practice","sales"],"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Free-form tags stored on the interview. Tags are also the coaching-catalogue mapping key: a catalogue directory (see the catalogue-tag-create / catalogue-tag-update endpoints) lists a coaching or persona session when the session's tags contain EVERY tag in that directory's `tags_interview_set_filter`. Only `active` sessions with visibility `merchant_public` (or the platform's own `public`) are listed.","example":["interview-practice","sales"],"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"interview_category":{"oneOf":[{"type":"string","description":"Job category shown on public listings above the department (free text), e.g. \"Ashore\". Interviews and positions. Blank is stored as null.","example":"Ashore","uniqueKey":"interview_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job category shown on public listings above the department (free text), e.g. \"Ashore\". Interviews and positions. Blank is stored as null.","example":"Ashore","uniqueKey":"interview_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_category","typeLabel":"string | null"},"emoji":{"oneOf":[{"type":"string","description":"Emoji marker shown in the admin lists. Interviews and positions. Blank is stored as null.","uniqueKey":"emoji.oneOf.0","typeLabel":"string"},{"type":"null","description":"Emoji marker shown in the admin lists. Interviews and positions. Blank is stored as null.","uniqueKey":"emoji.oneOf.1","typeLabel":"null"}],"uniqueKey":"emoji","typeLabel":"string | null"},"collect_resume_cover_letter":{"type":"string","enum":["hidden","optional","required"],"description":"Ask the candidate for a resume / cover letter: hidden, optional or required. Single-stage interviews only.","uniqueKey":"collect_resume_cover_letter","typeLabel":"enum\u003cstring>"},"allow_human_interview":{"type":"boolean","description":"A recruiter may hold the interview instead of the AI. Single-stage interviews only (an interview step of a position carries its own setting, see merchant-position-step-update).","uniqueKey":"allow_human_interview","typeLabel":"boolean"},"team":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["recruiter","sourcer","coordinator","hiring_manager","interviewer"],"description":"Role on the hiring team.","isRequired":true,"uniqueKey":"team.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"profile_id":{"type":"string","format":"uuid","description":"A person: an active or invited staff user of the company (profile.id).","uniqueKey":"team.items.[INDEX].profile_id","typeLabel":"string\u003cuuid>"},"profile_group_id":{"type":"string","format":"uuid","description":"A group of the company (profile_group.id).","uniqueKey":"team.items.[INDEX].profile_group_id","typeLabel":"string\u003cuuid>"}},"required":["role"],"uniqueKey":"team.items.[INDEX]","typeLabel":"object"},"maxItems":100,"description":"Multi-stage positions only (422 on an interview): the complete hiring team you want, replacing the current members (viewers, managed with position access, are kept). An empty array removes everyone. Needs the hiring team switched on for the company (else 403) and access to the position. Each member is a person (profile_id: an active or invited staff user of the company) or a group (profile_group_id), with a role. The answer carries the resulting `team`.","example":[{"profile_id":"00000000-0000-0000-0000-000000000001","role":"interviewer"}],"uniqueKey":"team","typeLabel":"object[]"},"custom_fields":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"custom_fields.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.additionalProperties","typeLabel":"null"},"description":"Company-defined position fields to set, {key: value}; a null value clears that field and keys you omit keep their value. Values are checked against the field definitions (option values, YYYY-MM-DD dates, {min, max, currency} ranges, user profile ids). Requires custom fields to be enabled for the company (else 403). Multi-stage positions only: on a single-stage interview the request is refused with 422.","example":{"cost_centre":"CC-100","contract_type":"permanent"},"uniqueKey":"custom_fields","typeLabel":"object"},"questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","description":"The question text shown to the candidate.","isRequired":true,"uniqueKey":"questions.items.[INDEX].question","typeLabel":"string"},"id":{"type":"string","description":"Identifier for this question. job-interview-get returns the question's real id here; send it back to job-interview-update so an unchanged question keeps its existing record (and with it its answer rules and any rendered avatar video). Also the handle another question references via conditional_question_main_id. On job-interview-create-from-array it is a caller-local value, only needed for those references.","uniqueKey":"questions.items.[INDEX].id","typeLabel":"string"},"duration":{"oneOf":[{"type":"number","description":"Answer duration in seconds for this question.","uniqueKey":"questions.items.[INDEX].duration.oneOf.0","typeLabel":"number"},{"type":"null","description":"Answer duration in seconds for this question.","uniqueKey":"questions.items.[INDEX].duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].duration","typeLabel":"number | null"},"mojito_language_code":{"oneOf":[{"type":"string","enum":["ar","bg","zh","hr","cs","da","nl","en","fil","fi","fr","de","el","hi","hu","id","it","ja","ko","ms","no","pl","pt","br","ro","ru","sk","es","sv","ta","th","tr","uk","vi"],"description":"Per-question language override (one of the listed codes). Inherits the interview language when omitted.","example":"en","uniqueKey":"questions.items.[INDEX].mojito_language_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["ar","bg","zh","hr","cs","da","nl","en","fil","fi","fr","de","el","hi","hu","id","it","ja","ko","ms","no","pl","pt","br","ro","ru","sk","es","sv","ta","th","tr","uk","vi"],"description":"Per-question language override (one of the listed codes). Inherits the interview language when omitted.","example":"en","uniqueKey":"questions.items.[INDEX].mojito_language_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].mojito_language_code","typeLabel":"enum\u003cstring> | null"},"label":{"oneOf":[{"type":"string","description":"Optional label/tag stored on the question.","uniqueKey":"questions.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional label/tag stored on the question.","uniqueKey":"questions.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].label","typeLabel":"string | null"},"is_conditional":{"oneOf":[{"type":"boolean","description":"A yes/no question that decides which follow-ups are asked (view 'with listening conditional'). Its follow-ups point at it with conditional_question_main_id.","uniqueKey":"questions.items.[INDEX].is_conditional.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A yes/no question that decides which follow-ups are asked (view 'with listening conditional'). Its follow-ups point at it with conditional_question_main_id.","uniqueKey":"questions.items.[INDEX].is_conditional.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].is_conditional","typeLabel":"boolean | null"},"is_without_scoring":{"oneOf":[{"type":"boolean","description":"Question is asked but not scored (view 'without scoring').","uniqueKey":"questions.items.[INDEX].is_without_scoring.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Question is asked but not scored (view 'without scoring').","uniqueKey":"questions.items.[INDEX].is_without_scoring.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].is_without_scoring","typeLabel":"boolean | null"},"is_candidate_asking_recruiter":{"oneOf":[{"type":"boolean","description":"Candidate-asks-recruiter prompt (view 'candidate asking recruiter').","uniqueKey":"questions.items.[INDEX].is_candidate_asking_recruiter.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Candidate-asks-recruiter prompt (view 'candidate asking recruiter').","uniqueKey":"questions.items.[INDEX].is_candidate_asking_recruiter.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].is_candidate_asking_recruiter","typeLabel":"boolean | null"},"is_expert":{"oneOf":[{"type":"boolean","description":"Expert listening question (view 'with listening expert').","uniqueKey":"questions.items.[INDEX].is_expert.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Expert listening question (view 'with listening expert').","uniqueKey":"questions.items.[INDEX].is_expert.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].is_expert","typeLabel":"boolean | null"},"is_multiple_choice":{"oneOf":[{"type":"boolean","description":"Multiple-choice question (view 'multiple choice').","uniqueKey":"questions.items.[INDEX].is_multiple_choice.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Multiple-choice question (view 'multiple choice').","uniqueKey":"questions.items.[INDEX].is_multiple_choice.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].is_multiple_choice","typeLabel":"boolean | null"},"question_alternatives":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].question_alternatives.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Alternative phrasings for the question.","uniqueKey":"questions.items.[INDEX].question_alternatives.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Alternative phrasings for the question.","uniqueKey":"questions.items.[INDEX].question_alternatives.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].question_alternatives","typeLabel":"string[] | null"},"conditional_question_main_id":{"oneOf":[{"type":"string","description":"For a follow-up question, the id (the \"id\" field above) of the yes/no question (is_conditional) in this same array that decides whether it is asked. The yes/no question must appear earlier in the array. Use conditional_question_answer to choose the answer that shows it.","uniqueKey":"questions.items.[INDEX].conditional_question_main_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"For a follow-up question, the id (the \"id\" field above) of the yes/no question (is_conditional) in this same array that decides whether it is asked. The yes/no question must appear earlier in the array. Use conditional_question_answer to choose the answer that shows it.","uniqueKey":"questions.items.[INDEX].conditional_question_main_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].conditional_question_main_id","typeLabel":"string | null"},"conditional_question_answer":{"oneOf":[{"type":"boolean","description":"With conditional_question_main_id: the answer to the yes/no question that shows this follow-up. `true` (the default) asks it after a yes, `false` after a no, so each answer can lead to its own follow-ups. Ignored on a question without conditional_question_main_id.","example":false,"uniqueKey":"questions.items.[INDEX].conditional_question_answer.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"With conditional_question_main_id: the answer to the yes/no question that shows this follow-up. `true` (the default) asks it after a yes, `false` after a no, so each answer can lead to its own follow-ups. Ignored on a question without conditional_question_main_id.","example":false,"uniqueKey":"questions.items.[INDEX].conditional_question_answer.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].conditional_question_answer","typeLabel":"boolean | null"},"is_skippable":{"oneOf":[{"type":"boolean","description":"The candidate may skip this question: the recorded (offline avatar) interview shows a Skip button on it, and a skipped question is saved without an answer. Defaults to false.","example":false,"uniqueKey":"questions.items.[INDEX].is_skippable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The candidate may skip this question: the recorded (offline avatar) interview shows a Skip button on it, and a skipped question is saved without an answer. Defaults to false.","example":false,"uniqueKey":"questions.items.[INDEX].is_skippable.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].is_skippable","typeLabel":"boolean | null"},"knowledge_base_id":{"oneOf":[{"type":"string","description":"Knowledge-base store id (uuid) the question draws context from.","uniqueKey":"questions.items.[INDEX].knowledge_base_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Knowledge-base store id (uuid) the question draws context from.","uniqueKey":"questions.items.[INDEX].knowledge_base_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].knowledge_base_id","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","description":"External identifier stored on the question. job-interview-update matches on this first, so an ATS that owns stable ids can send its own array and have the diff line up without round-tripping our ids.","uniqueKey":"questions.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"External identifier stored on the question. job-interview-update matches on this first, so an ATS that owns stable ids can send its own array and have the diff line up without round-tripping our ids.","uniqueKey":"questions.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].external_id","typeLabel":"string | null"},"external_data":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"questions.items.[INDEX].external_data.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].external_data.oneOf.0.additionalProperties","typeLabel":"null"},"description":"Arbitrary JSON metadata stored on the question.","uniqueKey":"questions.items.[INDEX].external_data.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"questions.items.[INDEX].external_data.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].external_data.oneOf.1.additionalProperties","typeLabel":"null"},"description":"Arbitrary JSON metadata stored on the question.","uniqueKey":"questions.items.[INDEX].external_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].external_data","typeLabel":"object | null"},"candidate_expectations_json":{"oneOf":[{"type":"object","properties":{"weak":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0.weak.items.[INDEX]","typeLabel":"string"},"description":"Baseline requirements every viable candidate should meet (table stakes).","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0.weak","typeLabel":"string[]"},"moderate":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0.moderate.items.[INDEX]","typeLabel":"string"},"description":"Requirements expected of a solid, competent candidate.","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0.moderate","typeLabel":"string[]"},"strong":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0.strong.items.[INDEX]","typeLabel":"string"},"description":"High-bar requirements only standout candidates clear.","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0.strong","typeLabel":"string[]"}},"description":"Per-question candidate expectations, bucketed by requirement level (weak/moderate/strong). Extra keys are preserved.","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"weak":{"type":"array","items":{"type":"string"},"description":"Baseline requirements every viable candidate should meet (table stakes)."},"moderate":{"type":"array","items":{"type":"string"},"description":"Requirements expected of a solid, competent candidate."},"strong":{"type":"array","items":{"type":"string"},"description":"High-bar requirements only standout candidates clear."}},"description":"Per-question candidate expectations, bucketed by requirement level (weak/moderate/strong). Extra keys are preserved.","uniqueKey":"questions.items.[INDEX].candidate_expectations_json.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].candidate_expectations_json","typeLabel":"object | null"}},"required":["question"],"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"questions.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].additionalProperties","typeLabel":"null"},"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"minItems":1,"description":"OPTIONAL. Omit this field entirely and the interview's questions are left exactly as they are — questions are only touched when you send the array. When you do send it, send the COMPLETE list you want the interview to end up with, in order, in the same format job-interview-create-from-array accepts and job-interview-get returns: there is no way to change a single question on its own, so read the interview, edit that array, and send the whole thing back. An empty array is rejected. It is applied as a DIFF, not a replace, so resending the array job-interview-get gave you changes nothing at all. Each entry is matched against what is stored — first on `external_id`, then on `id`, then on identical content — and: an entry matching an unchanged question keeps that question exactly as it is, including its answer rules and any rendered avatar video; an entry matching a question whose content differs unlinks the old question and creates a new one in its place (fields you omit are carried over from the old one); an entry matching nothing is created; and a stored question no entry matches is unlinked. `questions_diff` in the response reports exactly what was decided. Questions are shared records, so nothing is ever deleted — removing one only unlinks it from this interview, and an edit is always unlink-old + create-new so the change cannot leak into another interview reusing the same question. The welcome, thank-you and instructional-video steps are not part of this array and are left in place. Single-stage interviews only; for a multi-stage position, update its interview stages individually.","uniqueKey":"questions","typeLabel":"object[]"},"regenerate_candidate_expectations":{"type":"boolean","description":"Re-derive the interview-level `candidate_expectations_json` scoring rubric from the resulting question list, the way job-interview-create-from-array derives it at creation time. Only applies when `questions` is sent, the interview type is `interview`, and `candidate_expectations_json` is not also being set explicitly (an explicit value wins).","example":false,"uniqueKey":"regenerate_candidate_expectations","typeLabel":"boolean"},"type":{"type":"string","enum":["interview","coaching","assessment"],"description":"Product type of the interview. Changing it also re-derives `type_credit` (null for interview/assessment, otherwise interview_coach_manager) unless you send `type_credit` explicitly. Single-stage interviews only.","example":"interview","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"type_credit":{"oneOf":[{"type":"string","enum":["resume_check","interview_coach_starter","interview_coach_contributor","interview_coach_manager","cover_letter"],"description":"Credit bucket the session draws from. Only meaningful for candidate-paid coaching/persona sessions; hiring interviews and assessments are merchant-billed and carry null. Options — `resume_check`: Resume Builder credits. | `interview_coach_starter`: Coaching credits — starter tier. | `interview_coach_contributor`: Coaching credits — contributor tier. | `interview_coach_manager`: Coaching credits — manager tier. | `cover_letter`: Cover-letter credits.","example":"interview_coach_manager","uniqueKey":"type_credit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["resume_check","interview_coach_starter","interview_coach_contributor","interview_coach_manager","cover_letter"],"description":"Credit bucket the session draws from. Only meaningful for candidate-paid coaching/persona sessions; hiring interviews and assessments are merchant-billed and carry null. Options — `resume_check`: Resume Builder credits. | `interview_coach_starter`: Coaching credits — starter tier. | `interview_coach_contributor`: Coaching credits — contributor tier. | `interview_coach_manager`: Coaching credits — manager tier. | `cover_letter`: Cover-letter credits.","example":"interview_coach_manager","uniqueKey":"type_credit.oneOf.1","typeLabel":"null"}],"uniqueKey":"type_credit","typeLabel":"enum\u003cstring> | null"},"coach_plan":{"oneOf":[{"type":"string","enum":["demo","screening","2nd","3rd","closing","job-specific","other"],"description":"Coaching-plan stage this item belongs to, used by the coaching-plan progress view. Omit/null to leave it out of any plan. Options — `demo`: Demo session. | `screening`: Screening-interview practice. | `2nd`: Second-interview practice. | `3rd`: Third-interview practice. | `closing`: Closing / salary-negotiation practice. | `job-specific`: Job-specific coaching. | `other`: Anything that does not fit the other buckets.","example":"screening","uniqueKey":"coach_plan.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["demo","screening","2nd","3rd","closing","job-specific","other"],"description":"Coaching-plan stage this item belongs to, used by the coaching-plan progress view. Omit/null to leave it out of any plan. Options — `demo`: Demo session. | `screening`: Screening-interview practice. | `2nd`: Second-interview practice. | `3rd`: Third-interview practice. | `closing`: Closing / salary-negotiation practice. | `job-specific`: Job-specific coaching. | `other`: Anything that does not fit the other buckets.","example":"screening","uniqueKey":"coach_plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"coach_plan","typeLabel":"enum\u003cstring> | null"},"interview_template_id":{"type":"string","minLength":1,"description":"Id of the interview template (avatar/voice) to use. An id from merchant-avatar-list. Also decides the modality: see merchant-avatar-list.","example":"46b98d37-1557-4391-beca-03037ead19f2","uniqueKey":"interview_template_id","typeLabel":"string"},"knowledge_base_store_id":{"oneOf":[{"type":"string","description":"Knowledge base store id the interview draws context from; validated for existence. null unlinks it.","uniqueKey":"knowledge_base_store_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Knowledge base store id the interview draws context from; validated for existence. null unlinks it.","uniqueKey":"knowledge_base_store_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"knowledge_base_store_id","typeLabel":"string | null"},"recording":{"oneOf":[{"type":"string","enum":["audio_first_5_answers","audio_all","video_all","video_first_5_answers","none"],"description":"Cheating/proctoring detection mode for candidate answers — this is NOT a full session recording. Video options also record the candidate. Omit to keep the current mode; `none` switches it off (null does too). Options — `audio_first_5_answers`: Audio-only cheating detection, first 5 answers only. | `audio_all`: Audio-only cheating detection on every answer. | `video_all`: Audio + video cheating detection on every answer (candidate is recorded for all answers). | `video_first_5_answers`: Audio + video cheating detection, first 5 answers only. | `none`: Switch cheating detection off.","example":"video_all","uniqueKey":"recording.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["audio_first_5_answers","audio_all","video_all","video_first_5_answers","none"],"description":"Cheating/proctoring detection mode for candidate answers — this is NOT a full session recording. Video options also record the candidate. Omit to keep the current mode; `none` switches it off (null does too). Options — `audio_first_5_answers`: Audio-only cheating detection, first 5 answers only. | `audio_all`: Audio-only cheating detection on every answer. | `video_all`: Audio + video cheating detection on every answer (candidate is recorded for all answers). | `video_first_5_answers`: Audio + video cheating detection, first 5 answers only. | `none`: Switch cheating detection off.","example":"video_all","uniqueKey":"recording.oneOf.1","typeLabel":"null"}],"uniqueKey":"recording","typeLabel":"enum\u003cstring> | null"},"recording_full_session":{"oneOf":[{"type":"string","enum":["audio_all","video_all","none"],"description":"Full interview-session recording (includes the avatar and voice) produced as a single file. Independent of `recording`. Omit to keep the current setting; `none` switches it off (null does too). Options — `audio_all`: Record the whole session audio (avatar + candidate voice) into a single file. Adds +0.2 credits. | `video_all`: Record the whole session video + audio (avatar + candidate) into a single file. Adds +0.4 credits. | `none`: Switch the full-session recording off.","example":"video_all","uniqueKey":"recording_full_session.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["audio_all","video_all","none"],"description":"Full interview-session recording (includes the avatar and voice) produced as a single file. Independent of `recording`. Omit to keep the current setting; `none` switches it off (null does too). Options — `audio_all`: Record the whole session audio (avatar + candidate voice) into a single file. Adds +0.2 credits. | `video_all`: Record the whole session video + audio (avatar + candidate) into a single file. Adds +0.4 credits. | `none`: Switch the full-session recording off.","example":"video_all","uniqueKey":"recording_full_session.oneOf.1","typeLabel":"null"}],"uniqueKey":"recording_full_session","typeLabel":"enum\u003cstring> | null"},"result_view":{"type":"string","enum":["none","minimal","minimal_with_score","advanced","full","full_expand_scores"],"description":"Result screen shown to the candidate after finishing. With any value other than `none`, the candidate sees a results screen where they can provide feedback, record an intro video and edit the transcript, and must then submit the result; the value sets how much score/result detail is shown. Options — `none`: No results screen at all — the interview is submitted immediately when the candidate finishes (no feedback, intro video, transcript edit or manual submit step). | `minimal`: Minimal results layout, no score shown. | `minimal_with_score`: Minimal results layout including the overall score. | `advanced`: Advanced results layout with more detail. | `full`: Full results layout with all sections. | `full_expand_scores`: Full results with every score breakdown expanded.","example":"full","uniqueKey":"result_view","typeLabel":"enum\u003cstring>"},"candidate_video_introduction":{"oneOf":[{"type":"string","enum":["hidden","optional","required"],"description":"Whether a candidate video introduction is hidden, optional or required. null is treated like hidden.","uniqueKey":"candidate_video_introduction.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["hidden","optional","required"],"description":"Whether a candidate video introduction is hidden, optional or required. null is treated like hidden.","uniqueKey":"candidate_video_introduction.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidate_video_introduction","typeLabel":"enum\u003cstring> | null"},"interview_conversation_speed":{"oneOf":[{"type":"string","enum":["slower","normal","faster","fluent"],"description":"Conversation pace of the AI avatar. Omit/null keeps the template default pace. Options — `slower`: The avatar speaks more slowly — easier to follow for non-native speakers. | `normal`: Default speaking pace. | `faster`: The avatar speaks more quickly for a snappier conversation. | `fluent`: Talking pace: the avatar answers 300 ms after the candidate stops speaking. A pause mid-sentence also ends their turn.","example":"normal","uniqueKey":"interview_conversation_speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["slower","normal","faster","fluent"],"description":"Conversation pace of the AI avatar. Omit/null keeps the template default pace. Options — `slower`: The avatar speaks more slowly — easier to follow for non-native speakers. | `normal`: Default speaking pace. | `faster`: The avatar speaks more quickly for a snappier conversation. | `fluent`: Talking pace: the avatar answers 300 ms after the candidate stops speaking. A pause mid-sentence also ends their turn.","example":"normal","uniqueKey":"interview_conversation_speed.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_conversation_speed","typeLabel":"enum\u003cstring> | null"},"max_followups":{"oneOf":[{"type":"integer","minimum":0,"maximum":999,"description":"Maximum number of AI follow-up questions. 0 disables follow-ups; presets are 0-3 (none/low/normal/high) and custom values start at 4; null uses the template default (Normal).","example":2,"uniqueKey":"max_followups.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":999,"description":"Maximum number of AI follow-up questions. 0 disables follow-ups; presets are 0-3 (none/low/normal/high) and custom values start at 4; null uses the template default (Normal).","example":2,"uniqueKey":"max_followups.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_followups","typeLabel":"integer | null"},"max_duration":{"oneOf":[{"type":"number","description":"Live session limit in seconds. Also the basis for the credit multiplier.","example":1200,"uniqueKey":"max_duration.oneOf.0","typeLabel":"number"},{"type":"null","description":"Live session limit in seconds. Also the basis for the credit multiplier.","example":1200,"uniqueKey":"max_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_duration","typeLabel":"number | null"},"questions_random_subset":{"oneOf":[{"type":"number","minimum":0.01,"maximum":0.9,"description":"Ask only a random subset of the questions, as a fraction between 0.01 and 0.9. null asks all questions.","example":0.5,"uniqueKey":"questions_random_subset.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.01,"maximum":0.9,"description":"Ask only a random subset of the questions, as a fraction between 0.01 and 0.9. null asks all questions.","example":0.5,"uniqueKey":"questions_random_subset.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions_random_subset","typeLabel":"number | null"},"interview_attempts":{"type":"number","minimum":1,"maximum":20,"description":"Allowed candidate attempts (1-20). Stored as result_scoring.max_retries.","example":1,"uniqueKey":"interview_attempts","typeLabel":"number"},"required_pronunciation":{"oneOf":[{"type":"boolean","description":"Require pronunciation assessment (restricts to pronunciation-capable languages).","uniqueKey":"required_pronunciation.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Require pronunciation assessment (restricts to pronunciation-capable languages).","uniqueKey":"required_pronunciation.oneOf.1","typeLabel":"null"}],"uniqueKey":"required_pronunciation","typeLabel":"boolean | null"},"result_enable_edit_transcript":{"oneOf":[{"type":"boolean","description":"Allow editing the transcript on the result view.","uniqueKey":"result_enable_edit_transcript.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Allow editing the transcript on the result view.","uniqueKey":"result_enable_edit_transcript.oneOf.1","typeLabel":"null"}],"uniqueKey":"result_enable_edit_transcript","typeLabel":"boolean | null"},"candidate_expectations":{"oneOf":[{"type":"string","description":"Free-text candidate expectations.","uniqueKey":"candidate_expectations.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free-text candidate expectations.","uniqueKey":"candidate_expectations.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidate_expectations","typeLabel":"string | null"},"candidate_expectations_json":{"oneOf":[{"type":"object","properties":{"weak":{"type":"array","items":{"type":"string","uniqueKey":"candidate_expectations_json.oneOf.0.weak.items.[INDEX]","typeLabel":"string"},"description":"Baseline requirements every viable candidate should meet (table stakes).","uniqueKey":"candidate_expectations_json.oneOf.0.weak","typeLabel":"string[]"},"moderate":{"type":"array","items":{"type":"string","uniqueKey":"candidate_expectations_json.oneOf.0.moderate.items.[INDEX]","typeLabel":"string"},"description":"Requirements expected of a solid, competent candidate.","uniqueKey":"candidate_expectations_json.oneOf.0.moderate","typeLabel":"string[]"},"strong":{"type":"array","items":{"type":"string","uniqueKey":"candidate_expectations_json.oneOf.0.strong.items.[INDEX]","typeLabel":"string"},"description":"High-bar requirements only standout candidates clear.","uniqueKey":"candidate_expectations_json.oneOf.0.strong","typeLabel":"string[]"}},"description":"Structured candidate expectations (the scoring rubric), bucketed by requirement level (weak/moderate/strong). null clears the rubric. Extra keys are preserved.","uniqueKey":"candidate_expectations_json.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"weak":{"type":"array","items":{"type":"string"},"description":"Baseline requirements every viable candidate should meet (table stakes)."},"moderate":{"type":"array","items":{"type":"string"},"description":"Requirements expected of a solid, competent candidate."},"strong":{"type":"array","items":{"type":"string"},"description":"High-bar requirements only standout candidates clear."}},"description":"Structured candidate expectations (the scoring rubric), bucketed by requirement level (weak/moderate/strong). null clears the rubric. Extra keys are preserved.","uniqueKey":"candidate_expectations_json.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidate_expectations_json","typeLabel":"object | null"},"custom_scoring":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"custom_scoring.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_scoring.oneOf.0.additionalProperties","typeLabel":"null"},"description":"Result-scoring overrides (max_score, early_stop, speech_cadence, ai_pronunciation, sentiment_analysis, ai_assessment_answer, ai_assessment_resume, ai_assessment_session). Merged onto the stored configuration, so keys you omit keep their current value.","uniqueKey":"custom_scoring.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"custom_scoring.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_scoring.oneOf.1.additionalProperties","typeLabel":"null"},"description":"Result-scoring overrides (max_score, early_stop, speech_cadence, ai_pronunciation, sentiment_analysis, ai_assessment_answer, ai_assessment_resume, ai_assessment_session). Merged onto the stored configuration, so keys you omit keep their current value.","uniqueKey":"custom_scoring.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_scoring","typeLabel":"object | null"},"pdf_export_auto_config":{"oneOf":[{"type":"object","properties":{"mojito_language_code":{"type":"string","enum":["ar","bg","zh","hr","cs","da","nl","en","fil","fi","fr","de","el","hi","hu","id","it","ja","ko","ms","no","pl","pt","br","ro","ru","sk","es","sv","ta","th","tr","uk","vi"],"description":"Report language code (one of the listed codes).","example":"en","uniqueKey":"pdf_export_auto_config.oneOf.0.mojito_language_code","typeLabel":"enum\u003cstring>"},"contact_details":{"type":"boolean","description":"Include candidate contact details.","uniqueKey":"pdf_export_auto_config.oneOf.0.contact_details","typeLabel":"boolean"},"ai_recruiter_assessment":{"type":"boolean","description":"Include the AI recruiter assessment.","uniqueKey":"pdf_export_auto_config.oneOf.0.ai_recruiter_assessment","typeLabel":"boolean"},"ai_scoring_rubric":{"type":"boolean","description":"Include the AI scoring rubric.","uniqueKey":"pdf_export_auto_config.oneOf.0.ai_scoring_rubric","typeLabel":"boolean"},"analytics":{"type":"boolean","description":"Include analytics.","uniqueKey":"pdf_export_auto_config.oneOf.0.analytics","typeLabel":"boolean"},"files":{"type":"boolean","description":"Include uploaded candidate files.","uniqueKey":"pdf_export_auto_config.oneOf.0.files","typeLabel":"boolean"},"transcript":{"type":"boolean","description":"Include the interview transcript.","uniqueKey":"pdf_export_auto_config.oneOf.0.transcript","typeLabel":"boolean"},"answer_recording":{"type":"boolean","description":"Include per-answer recordings.","uniqueKey":"pdf_export_auto_config.oneOf.0.answer_recording","typeLabel":"boolean"},"session_recording":{"type":"boolean","description":"Include the full-session recording.","uniqueKey":"pdf_export_auto_config.oneOf.0.session_recording","typeLabel":"boolean"},"group_by_question":{"type":"boolean","description":"Group transcript answers by expected question.","uniqueKey":"pdf_export_auto_config.oneOf.0.group_by_question","typeLabel":"boolean"},"template":{"type":"string","enum":["classic","modern","one_pager"],"description":"Report layout: classic, modern, or one_pager. Omit for the merchant default (modern when unset).","uniqueKey":"pdf_export_auto_config.oneOf.0.template","typeLabel":"enum\u003cstring>"}},"description":"Auto-generate a candidate PDF report with these options once the interview completes. null disables auto-export.","uniqueKey":"pdf_export_auto_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"mojito_language_code":{"type":"string","enum":["ar","bg","zh","hr","cs","da","nl","en","fil","fi","fr","de","el","hi","hu","id","it","ja","ko","ms","no","pl","pt","br","ro","ru","sk","es","sv","ta","th","tr","uk","vi"],"description":"Report language code (one of the listed codes).","example":"en"},"contact_details":{"type":"boolean","description":"Include candidate contact details."},"ai_recruiter_assessment":{"type":"boolean","description":"Include the AI recruiter assessment."},"ai_scoring_rubric":{"type":"boolean","description":"Include the AI scoring rubric."},"analytics":{"type":"boolean","description":"Include analytics."},"files":{"type":"boolean","description":"Include uploaded candidate files."},"transcript":{"type":"boolean","description":"Include the interview transcript."},"answer_recording":{"type":"boolean","description":"Include per-answer recordings."},"session_recording":{"type":"boolean","description":"Include the full-session recording."},"group_by_question":{"type":"boolean","description":"Group transcript answers by expected question."},"template":{"type":"string","enum":["classic","modern","one_pager"],"description":"Report layout: classic, modern, or one_pager. Omit for the merchant default (modern when unset)."}},"description":"Auto-generate a candidate PDF report with these options once the interview completes. null disables auto-export.","uniqueKey":"pdf_export_auto_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"pdf_export_auto_config","typeLabel":"object | null"},"interview_type":{"oneOf":[{"type":"string","enum":["pre-screening","pre-screening-with-test-questions","second-interview","remote-freelancer-verification","strength-based-interview","potential-based-interview","process-verification-from-knowledge-base","knockout-screening"],"description":"Interview style — configures the AI avatar and the follow-up questions it generates during the interview. Stored in creation_parameters; existing questions are NOT regenerated. Options — `pre-screening`: Pre-screening — quick qualification check focusing on basic requirements and availability. | `pre-screening-with-test-questions`: Pre-screening with test questions — pre-screening plus practical questions to test relevant skills. | `second-interview`: Second round interview — deeper dive for candidates who passed initial screening. | `remote-freelancer-verification`: Remote worker verification — verify remote work capabilities and communication skills. | `strength-based-interview`: Strength-based interview — focus on what candidates enjoy and excel at to predict job satisfaction. | `potential-based-interview`: Potential-based interview — assess learning ability and growth potential rather than past experience. | `process-verification-from-knowledge-base`: Knowledge Base interview — generate questions from your knowledge base documents. | `knockout-screening`: Knock-out screening — a short (about 5 minute) check of the role's must-haves with closed questions; ends early, politely, when a must-have is clearly not met. On creation it defaults custom_scoring.early_stop to true (where the avatar supports early stop) and max_followups to 1 unless you send them.","example":"pre-screening-with-test-questions","uniqueKey":"interview_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pre-screening","pre-screening-with-test-questions","second-interview","remote-freelancer-verification","strength-based-interview","potential-based-interview","process-verification-from-knowledge-base","knockout-screening"],"description":"Interview style — configures the AI avatar and the follow-up questions it generates during the interview. Stored in creation_parameters; existing questions are NOT regenerated. Options — `pre-screening`: Pre-screening — quick qualification check focusing on basic requirements and availability. | `pre-screening-with-test-questions`: Pre-screening with test questions — pre-screening plus practical questions to test relevant skills. | `second-interview`: Second round interview — deeper dive for candidates who passed initial screening. | `remote-freelancer-verification`: Remote worker verification — verify remote work capabilities and communication skills. | `strength-based-interview`: Strength-based interview — focus on what candidates enjoy and excel at to predict job satisfaction. | `potential-based-interview`: Potential-based interview — assess learning ability and growth potential rather than past experience. | `process-verification-from-knowledge-base`: Knowledge Base interview — generate questions from your knowledge base documents. | `knockout-screening`: Knock-out screening — a short (about 5 minute) check of the role's must-haves with closed questions; ends early, politely, when a must-have is clearly not met. On creation it defaults custom_scoring.early_stop to true (where the avatar supports early stop) and max_followups to 1 unless you send them.","example":"pre-screening-with-test-questions","uniqueKey":"interview_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_type","typeLabel":"enum\u003cstring> | null"},"interview_tone":{"oneOf":[{"type":"string","enum":["relaxed","simple","professional","persuasive","exact"],"description":"Tone — configures the AI avatar's speaking style and the follow-up questions it generates. Stored in creation_parameters; existing questions are NOT regenerated. Case-insensitive; omit to keep the current tone. Options — `relaxed`: Friendly and conversational tone that helps candidates feel at ease. | `simple`: Plain language at CEFR A2 level — short sentences and simple words. | `professional`: Formal and business-like approach suitable for senior roles. | `persuasive`: Engaging style that encourages candidates to elaborate. | `exact`: Asks the questions exactly as provided, without rephrasing — for interviews built from your own questions where the wording is a script.","example":"professional","uniqueKey":"interview_tone.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["relaxed","simple","professional","persuasive","exact"],"description":"Tone — configures the AI avatar's speaking style and the follow-up questions it generates. Stored in creation_parameters; existing questions are NOT regenerated. Case-insensitive; omit to keep the current tone. Options — `relaxed`: Friendly and conversational tone that helps candidates feel at ease. | `simple`: Plain language at CEFR A2 level — short sentences and simple words. | `professional`: Formal and business-like approach suitable for senior roles. | `persuasive`: Engaging style that encourages candidates to elaborate. | `exact`: Asks the questions exactly as provided, without rephrasing — for interviews built from your own questions where the wording is a script.","example":"professional","uniqueKey":"interview_tone.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_tone","typeLabel":"enum\u003cstring> | null"},"seniority_level":{"oneOf":[{"type":"string","enum":["entry-level","intermediate","senior","managerial","director","executive"],"description":"Target seniority level for the role; omit to keep the current one. Options — `entry-level`: Early-career or graduate roles. | `intermediate`: Some experience required. | `senior`: Experienced professional. | `managerial`: Team or department lead. | `director`: Director-level responsibility. | `executive`: C-suite or executive role.","example":"senior","uniqueKey":"seniority_level.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["entry-level","intermediate","senior","managerial","director","executive"],"description":"Target seniority level for the role; omit to keep the current one. Options — `entry-level`: Early-career or graduate roles. | `intermediate`: Some experience required. | `senior`: Experienced professional. | `managerial`: Team or department lead. | `director`: Director-level responsibility. | `executive`: C-suite or executive role.","example":"senior","uniqueKey":"seniority_level.oneOf.1","typeLabel":"null"}],"uniqueKey":"seniority_level","typeLabel":"enum\u003cstring> | null"},"hiring_for_company":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"End-employer name. Omit/null when hiring for yourself, 'undisclosed' for an unnamed external client, or the client's company name.","example":"Unimo Enterprises","uniqueKey":"hiring_for_company.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"End-employer name. Omit/null when hiring for yourself, 'undisclosed' for an unnamed external client, or the client's company name.","example":"Unimo Enterprises","uniqueKey":"hiring_for_company.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"hiring_for_company.oneOf.0.name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Short description of the end employer, used as background context by the agent.","example":"Unimo Enterprises is a leading logistics and supply chain solutions provider.","uniqueKey":"hiring_for_company.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Short description of the end employer, used as background context by the agent.","example":"Unimo Enterprises is a leading logistics and supply chain solutions provider.","uniqueKey":"hiring_for_company.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"hiring_for_company.oneOf.0.description","typeLabel":"string | null"},"location":{"oneOf":[{"type":"string","description":"Primary location of the end employer.","example":"Sri Lanka","uniqueKey":"hiring_for_company.oneOf.0.location.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary location of the end employer.","example":"Sri Lanka","uniqueKey":"hiring_for_company.oneOf.0.location.oneOf.1","typeLabel":"null"}],"uniqueKey":"hiring_for_company.oneOf.0.location","typeLabel":"string | null"},"sector":{"oneOf":[{"type":"string","description":"Industry / sector of the end employer.","example":"Logistics and Supply Chain","uniqueKey":"hiring_for_company.oneOf.0.sector.oneOf.0","typeLabel":"string"},{"type":"null","description":"Industry / sector of the end employer.","example":"Logistics and Supply Chain","uniqueKey":"hiring_for_company.oneOf.0.sector.oneOf.1","typeLabel":"null"}],"uniqueKey":"hiring_for_company.oneOf.0.sector","typeLabel":"string | null"},"company_size":{"oneOf":[{"type":"string","description":"Approximate headcount of the end employer.","example":"100-200","uniqueKey":"hiring_for_company.oneOf.0.company_size.oneOf.0","typeLabel":"string"},{"type":"null","description":"Approximate headcount of the end employer.","example":"100-200","uniqueKey":"hiring_for_company.oneOf.0.company_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"hiring_for_company.oneOf.0.company_size","typeLabel":"string | null"}},"description":"Who the position is really for. null (or an object with name null/blank) means hiring for yourself; { name: 'undisclosed' } for an unnamed external client; or { name: '\u003ccompany>' } plus optional description/location/sector/company_size. Stored in creation_parameters.hiring_for_company.","example":{"name":"undisclosed"},"uniqueKey":"hiring_for_company.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"End-employer name. Omit/null when hiring for yourself, 'undisclosed' for an unnamed external client, or the client's company name.","example":"Unimo Enterprises"},{"type":"null","description":"End-employer name. Omit/null when hiring for yourself, 'undisclosed' for an unnamed external client, or the client's company name.","example":"Unimo Enterprises"}]},"description":{"oneOf":[{"type":"string","description":"Short description of the end employer, used as background context by the agent.","example":"Unimo Enterprises is a leading logistics and supply chain solutions provider."},{"type":"null","description":"Short description of the end employer, used as background context by the agent.","example":"Unimo Enterprises is a leading logistics and supply chain solutions provider."}]},"location":{"oneOf":[{"type":"string","description":"Primary location of the end employer.","example":"Sri Lanka"},{"type":"null","description":"Primary location of the end employer.","example":"Sri Lanka"}]},"sector":{"oneOf":[{"type":"string","description":"Industry / sector of the end employer.","example":"Logistics and Supply Chain"},{"type":"null","description":"Industry / sector of the end employer.","example":"Logistics and Supply Chain"}]},"company_size":{"oneOf":[{"type":"string","description":"Approximate headcount of the end employer.","example":"100-200"},{"type":"null","description":"Approximate headcount of the end employer.","example":"100-200"}]}},"description":"Who the position is really for. null (or an object with name null/blank) means hiring for yourself; { name: 'undisclosed' } for an unnamed external client; or { name: '\u003ccompany>' } plus optional description/location/sector/company_size. Stored in creation_parameters.hiring_for_company.","example":{"name":"undisclosed"},"uniqueKey":"hiring_for_company.oneOf.1","typeLabel":"null"}],"uniqueKey":"hiring_for_company","typeLabel":"object | null"}},"required":["position_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"position_id":"00000000-0000-0000-0000-000000000000","status":"active","visibility":"merchant_public","environment":"production","name":"Project manager","code":"\u003cstring>","location":"remote","cover_image_url":"\u003cstring>","description":"\u003cstring>","description_long":"\u003cstring>","interview_department":"Engineering","interview_salary":"$80k - $100k","interview_available_till":"2026-12-31","recruiter_profile_id":"\u003cstring>","country_availability":{"countries_allowed":["PH","IN"],"countries_allowed_eu":true,"countries_blocked":["US"],"countries_blocked_eu":true},"tags":["interview-practice","sales"],"interview_category":"Ashore","emoji":"\u003cstring>","allow_human_interview":true,"team":[{"profile_id":"00000000-0000-0000-0000-000000000001","role":"interviewer"}],"custom_fields":{"cost_centre":"CC-100","contract_type":"permanent"},"questions":[{"question":"\u003cstring>","id":"\u003cstring>","duration":123,"mojito_language_code":"en","label":"\u003cstring>","is_conditional":true,"is_without_scoring":true,"is_candidate_asking_recruiter":true,"is_expert":true,"is_multiple_choice":true,"question_alternatives":["\u003cstring>"],"conditional_question_main_id":"\u003cstring>","conditional_question_answer":false,"is_skippable":false,"knowledge_base_id":"\u003cstring>","external_id":"\u003cstring>","external_data":{},"candidate_expectations_json":{"weak":["\u003cstring>"],"moderate":["\u003cstring>"],"strong":["\u003cstring>"]}}],"regenerate_candidate_expectations":false,"type":"interview","type_credit":"interview_coach_manager","coach_plan":"screening","interview_template_id":"46b98d37-1557-4391-beca-03037ead19f2","knowledge_base_store_id":"\u003cstring>","recording":"video_all","recording_full_session":"video_all","result_view":"full","interview_conversation_speed":"normal","max_followups":2,"max_duration":1200,"questions_random_subset":0.5,"interview_attempts":1,"required_pronunciation":true,"result_enable_edit_transcript":true,"candidate_expectations":"\u003cstring>","candidate_expectations_json":{"weak":["\u003cstring>"],"moderate":["\u003cstring>"],"strong":["\u003cstring>"]},"custom_scoring":{},"pdf_export_auto_config":{"mojito_language_code":"en","contact_details":true,"ai_recruiter_assessment":true,"ai_scoring_rubric":true,"analytics":true,"files":true,"transcript":true,"answer_recording":true,"session_recording":true,"group_by_question":true},"interview_type":"pre-screening-with-test-questions","interview_tone":"professional","seniority_level":"senior","hiring_for_company":{"name":"undisclosed"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c7c4e772-f10b-48e6-bd79-8ea2e0cf1943":{"description":"Interview / position updated.","content":{"application/json":{"schema":{"type":"object","properties":{"position_id":{"type":"string","description":"The id that was updated.","isRequired":true,"uniqueKey":"position_id","typeLabel":"string"},"is_multistage":{"type":"boolean","description":"True when the id resolved to a multi-stage position (position_def_set) rather than a single interview.","isRequired":true,"uniqueKey":"is_multistage","typeLabel":"boolean"},"updated_fields":{"type":"array","items":{"type":"string","uniqueKey":"updated_fields.items.[INDEX]","typeLabel":"string"},"description":"Names of the stored columns that were written, plus `status` when the publication status was changed, `questions` when the question list was diffed, `custom_fields` and `team` when those were set.","example":["name","tags"],"isRequired":true,"uniqueKey":"updated_fields","typeLabel":"string[]"},"questions_diff":{"type":"object","properties":{"kept":{"type":"array","items":{"type":"string","uniqueKey":"questions_diff.kept.items.[INDEX]","typeLabel":"string"},"description":"Questions left exactly as they were, record and all.","isRequired":true,"uniqueKey":"questions_diff.kept","typeLabel":"string[]"},"added":{"type":"array","items":{"type":"string","uniqueKey":"questions_diff.added.items.[INDEX]","typeLabel":"string"},"description":"Ids of the questions created for entries that matched nothing stored.","isRequired":true,"uniqueKey":"questions_diff.added","typeLabel":"string[]"},"removed":{"type":"array","items":{"type":"string","uniqueKey":"questions_diff.removed.items.[INDEX]","typeLabel":"string"},"description":"Ids unlinked because no entry in the request matched them. The question records themselves still exist.","isRequired":true,"uniqueKey":"questions_diff.removed","typeLabel":"string[]"},"replaced":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The id that was unlinked.","isRequired":true,"uniqueKey":"questions_diff.replaced.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","description":"The id of the question created in its place.","isRequired":true,"uniqueKey":"questions_diff.replaced.items.[INDEX].to","typeLabel":"string"}},"required":["from","to"],"uniqueKey":"questions_diff.replaced.items.[INDEX]","typeLabel":"object"},"description":"Edited questions: the old record was unlinked and a new one created, so the change cannot leak into other interviews reusing it.","isRequired":true,"uniqueKey":"questions_diff.replaced","typeLabel":"object[]"},"question_ids":{"type":"array","items":{"type":"string","uniqueKey":"questions_diff.question_ids.items.[INDEX]","typeLabel":"string"},"description":"The interview's full ordered step list after the update, including the welcome / thank-you / instructional steps this endpoint does not manage.","isRequired":true,"uniqueKey":"questions_diff.question_ids","typeLabel":"string[]"},"reactivated":{"type":"boolean","description":"True when the interview was already active and was re-published so the new questions go live.","isRequired":true,"uniqueKey":"questions_diff.reactivated","typeLabel":"boolean"}},"required":["kept","added","removed","replaced","question_ids","reactivated"],"description":"What the question diff decided, question by question. Absent when `questions` was not sent.","uniqueKey":"questions_diff","typeLabel":"object"},"team":{"type":"object","description":"The hiring team after the change. Absent when `team` was not sent.","required":["enabled","owner","members"],"properties":{"enabled":{"type":"boolean","description":"Whether the company has the hiring team switched on (the hiring_team feature); members is empty while it is off.","isRequired":true,"uniqueKey":"team.enabled","typeLabel":"boolean"},"owner":{"oneOf":[{"type":"object","properties":{"profile_id":{"oneOf":[{"type":"string","description":"Owning recruiter (profile.id).","isRequired":true,"uniqueKey":"team.owner.oneOf.0.profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Owning recruiter (profile.id).","isRequired":true,"uniqueKey":"team.owner.oneOf.0.profile_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.owner.oneOf.0.profile_id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Name.","isRequired":true,"uniqueKey":"team.owner.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name.","isRequired":true,"uniqueKey":"team.owner.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.owner.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"E-mail.","isRequired":true,"uniqueKey":"team.owner.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"E-mail.","isRequired":true,"uniqueKey":"team.owner.oneOf.0.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.owner.oneOf.0.email","typeLabel":"string | null"}},"required":["profile_id","name","email"],"description":"The position's recruiter (recruiter_profile_id); null when none.","isRequired":true,"uniqueKey":"team.owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"profile_id":{"oneOf":[{"type":"string","description":"Owning recruiter (profile.id)."},{"type":"null","description":"Owning recruiter (profile.id)."}]},"name":{"oneOf":[{"type":"string","description":"Name."},{"type":"null","description":"Name."}]},"email":{"oneOf":[{"type":"string","description":"E-mail."},{"type":"null","description":"E-mail."}]}},"required":["profile_id","name","email"],"description":"The position's recruiter (recruiter_profile_id); null when none.","isRequired":true,"uniqueKey":"team.owner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.owner","typeLabel":"object | null"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Membership id (position_team.id).","isRequired":true,"uniqueKey":"team.members.items.[INDEX].id","typeLabel":"string"},"role":{"type":"string","enum":["recruiter","sourcer","coordinator","hiring_manager","interviewer","viewer"],"description":"Role on the hiring team.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"profile_id":{"oneOf":[{"type":"string","description":"A person (profile.id); null for a group.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A person (profile.id); null for a group.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].profile_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.members.items.[INDEX].profile_id","typeLabel":"string | null"},"profile_group_id":{"oneOf":[{"type":"string","description":"A group (profile_group.id); null for a person.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].profile_group_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A group (profile_group.id); null for a person.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].profile_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.members.items.[INDEX].profile_group_id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Person or group name.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Person or group name.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.members.items.[INDEX].name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"E-mail of a person.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","description":"E-mail of a person.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.members.items.[INDEX].email","typeLabel":"string | null"},"group_name":{"oneOf":[{"type":"string","description":"Group name.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].group_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Group name.","isRequired":true,"uniqueKey":"team.members.items.[INDEX].group_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.members.items.[INDEX].group_name","typeLabel":"string | null"},"group_member_count":{"oneOf":[{"type":"number","description":"People in a group (with its subgroups).","isRequired":true,"uniqueKey":"team.members.items.[INDEX].group_member_count.oneOf.0","typeLabel":"number"},{"type":"null","description":"People in a group (with its subgroups).","isRequired":true,"uniqueKey":"team.members.items.[INDEX].group_member_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"team.members.items.[INDEX].group_member_count","typeLabel":"number | null"}},"required":["id","role","profile_id","profile_group_id","name","email","group_name","group_member_count"],"uniqueKey":"team.members.items.[INDEX]","typeLabel":"object"},"description":"Members by role, then name.","isRequired":true,"uniqueKey":"team.members","typeLabel":"object[]"}},"uniqueKey":"team","typeLabel":"object"}},"required":["position_id","is_multistage","updated_fields"],"description":"Confirmation of what was updated.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"position_id":"\u003cstring>","is_multistage":true,"updated_fields":["name","tags"],"questions_diff":{"kept":["\u003cstring>"],"added":["\u003cstring>"],"removed":["\u003cstring>"],"replaced":[{"from":"\u003cstring>","to":"\u003cstring>"}],"question_ids":["\u003cstring>"],"reactivated":true},"team":{"enabled":true,"owner":{"profile_id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>"},"members":[{"id":"\u003cstring>","role":"recruiter","profile_id":"\u003cstring>","profile_group_id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","group_name":"\u003cstring>","group_member_count":123}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6eededef-494b-4141-b95e-3118582fed9e":{"description":"Missing, expired or invalid access token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"6a5c811a-aa2d-4214-a193-73c2bfce9232":{"description":"Your token is not allowed to use this endpoint (it is not a merchant, merchant owner or admin token), or for `team`: the hiring team is switched off for the company (hiring_team) or you are not on the position's access list.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"a9a75482-7470-4f30-8541-a502a1c94f3c":{"description":"No interview or position found for the given id (or hidden by row-level security).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"2fa2ecc5-c5b4-4dbb-b046-daffa7fc7dff":{"description":"A concurrent change of the same hiring team; read the position and try again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"15758c9e-0b8f-48ed-9483-a3bea2e95e4d":{"description":"Validation error (unknown enum value, out-of-range number, unresolved template/language/knowledge-base id, an interview-only field sent for a multi-stage position, `team` or `custom_fields` on an interview, an empty `questions` array, a question change on an active interview using an offline avatar template, a recruiter_profile_id that is not an active owner, recruiter or admin of the company, an ineligible team member, or status / visibility on the AI step of a position).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"38eda7a1-161f-4360-86e1-d6b07270c1bb":{"description":"Server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b373de9d-d42d-4695-8805-97206683ce3a":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"454fcb62-7052-4847-a728-ecf5ade065a6":{"url":"https://cool.jobmojito.com/functions/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://cool.jobmojito.com/functions/v1/openapi"},"subdomain":"jobmojito","siteName":"JobMojito Developer / Agent","title":"Update an interview or position - JobMojito Developer / Agent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T15:00:44.145Z","originalFileLocation":"api-reference/interviews/update-an-interview-or-position.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=\"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send questions; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and questions_diff in the response for what was decided. Questions of an interview that is already active can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to draft first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. mojito_language_code cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring team; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).\">\u003cmeta data-mint-head name=\"application-name\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_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/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update an interview or position - JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send questions; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and questions_diff in the response for what was decided. Questions of an interview that is already active can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to draft first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. mojito_language_code cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring team; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Interviews\u0026amp;title=Update+an+interview+or+position\u0026amp;description=Updates+the+configuration+of+an+existing+interview+%28single-stage%29+or+position+%28multi-stage%29.+Only+the+fields+present+in+the+request+body+are+written+%E2%80%94+everythin\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=ea2ec9b11974509f289df232f7737fa11698b09a8c9d3f0e0e371a59e05c2379\">\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 an interview or position - JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send questions; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and questions_diff in the response for what was decided. Questions of an interview that is already active can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to draft first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. mojito_language_code cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring team; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Interviews\u0026amp;title=Update+an+interview+or+position\u0026amp;description=Updates+the+configuration+of+an+existing+interview+%28single-stage%29+or+position+%28multi-stage%29.+Only+the+fields+present+in+the+request+body+are+written+%E2%80%94+everythin\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=ea2ec9b11974509f289df232f7737fa11698b09a8c9d3f0e0e371a59e05c2379\">\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/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#639C42\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/interviews/update-an-interview-or-position.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.jobmojito.com/#organization\",\"name\":\"JobMojito Developer / Agent\",\"url\":\"https://developer.jobmojito.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=6c00cb5f3104ffb6325dacc0818bba69\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.jobmojito.com#website\",\"name\":\"JobMojito Developer / Agent\",\"url\":\"https://developer.jobmojito.com\",\"publisher\":{\"@id\":\"https://developer.jobmojito.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position#webpage\",\"url\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position\",\"name\":\"Update an interview or position\",\"description\":\"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send questions; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and questions_diff in the response for what was decided. Questions of an interview that is already active can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to draft first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. mojito_language_code cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring team; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).\",\"dateModified\":\"2026-11-09T15:00:44.145Z\",\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Interviews\",\"item\":\"https://developer.jobmojito.com/api-reference/interviews/create-a-new-interview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update an interview or position\",\"item\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position#apireference\",\"headline\":\"Update an interview or position\",\"name\":\"Update an interview or position\",\"description\":\"Updates the configuration of an existing interview (single-stage) or position (multi-stage). Only the fields present in the request body are written — everything else keeps its current value, and sending null clears a nullable field. The question list is only touched when you send questions; omit that field and the questions are left exactly as they are. When sent, it must be the complete list and is applied as a diff against what is stored (matched on external_id, then id, then identical content), so unchanged questions keep their existing records, edited ones are unlinked and re-created, and dropped ones are unlinked — and re-sending the array job-interview-get returned changes nothing. See the field description, and questions_diff in the response for what was decided. Questions of an interview that is already active can only be changed on interactive avatar templates, where re-publishing is instant; on the offline (pre-rendered video) templates set the interview back to draft first. The welcome / thank-you messages and the instructional-video screen are stored as steps rather than questions and are never changed here. mojito_language_code cannot be changed — the existing questions and rendered videos are in the original language — so create a new interview to change language. A multi-stage position only carries the shared identity fields (name, code, location, description, description_long, cover_image_url, department, salary, available_till, recruiter, status, visibility, hiring_for_company, tags, interview_category, emoji, custom_fields) and its hiring team; sending an interview-only field for a position is a 422. The AI interview step of a position can be edited here (questions, settings), but its status and visibility follow the position (422).\",\"url\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position\",\"mainEntityOfPage\":{\"@id\":\"https://developer.jobmojito.com/api-reference/interviews/update-an-interview-or-position#webpage\"},\"dateModified\":\"2026-11-09T15:00:44.145Z\",\"publisher\":{\"@id\":\"https://developer.jobmojito.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"JobMojito Developer / Agent\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"JobMojito Developer / Agent\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/interviews/update-an-interview-or-position.md","siteName":"JobMojito Developer / Agent","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"Interviews","pages":[{"title":"Create a new interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create","href":"/api-reference/interviews/create-a-new-interview"},{"title":"Create an interview from an array of questions","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create-from-array","href":"/api-reference/interviews/create-an-interview-from-an-array-of-questions"},{"title":"Create an interview for a candidate and return an access token URL","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create-for-candidate-with-token","href":"/api-reference/interviews/create-an-interview-for-a-candidate-and-return-an-access-token-url"},{"title":"Create a role-play — coaching persona or interview-portal role-play (choose with `portal`)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /persona-create","href":"/api-reference/interviews/create-a-role-play-—-coaching-persona-or-interview-portal-role-play-choose-with-`portal`"},{"title":"Get interview definition","description":"Retrieves the interview definition for a given interview-definition id or position id. Returns the compiled `calc_definition_json`, the ordered `questions` array (in the same format job-interview-create-from-array accepts, so it round-trips into job-interview-update) plus basic metadata. For a multi-stage position, `include` adds the process steps (with meeting slots), the hiring team, the vacancy lifecycle with openings, and the publishing window. Company staff only (owners, recruiters, hiring managers, admins); access is subject to the caller's row-level security, so a confidential position you are not on answers 404.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /job-interview-get","href":"/api-reference/interviews/get-interview-definition"},{"title":"Update an interview or position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-update","href":"/api-reference/interviews/update-an-interview-or-position"},{"title":"Set interview state","description":"Changes the publication status of an interview or position (draft, active, archived, preparing, completed, deleted), the vacancy lifecycle of a position (open, applications_closed, on_hold, filled, cancelled, closed), and/or manages its embed key. Provide at least one of `status`, `lifecycle` or `is_embedded`. The id is read with your own access first: an id you cannot see answers 404. Moving an open position to filled, cancelled or closed archives it: when the company has the position-closed notice switched on, every candidate with an open application then gets the position-closed e-mail (at once or on the company's e-mail schedule). ","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-set-state","href":"/api-reference/interviews/set-interview-state"},{"title":"Generate a signed interview URL","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-token","href":"/api-reference/interviews/generate-a-signed-interview-url"},{"title":"Register users for an interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-register-users","href":"/api-reference/interviews/register-users-for-an-interview"},{"title":"List interview definitions","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-interview-list","href":"/api-reference/interviews/list-interview-definitions"}]},{"group":"Positions","pages":[{"title":"Set the steps of a draft position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-process-save","href":"/api-reference/positions/set-the-steps-of-a-draft-position"},{"title":"Change the settings of a position step","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-step-update","href":"/api-reference/positions/change-the-settings-of-a-position-step"},{"title":"Create, change or delete a meeting slot","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-meeting-slot-manage","href":"/api-reference/positions/create-change-or-delete-a-meeting-slot"},{"title":"Copy a position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-duplicate","href":"/api-reference/positions/copy-a-position"},{"title":"Copy an interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-interview-duplicate","href":"/api-reference/positions/copy-an-interview"}]},{"group":"Coaching catalogue","pages":[{"title":"Create a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /catalogue-tag-create","href":"/api-reference/coaching-catalogue/create-a-coaching-catalogue-directory"},{"title":"Update a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /catalogue-tag-update","href":"/api-reference/coaching-catalogue/update-a-coaching-catalogue-directory"},{"title":"Get a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /catalogue-tag-get","href":"/api-reference/coaching-catalogue/get-a-coaching-catalogue-directory"},{"title":"List coaching catalogue directories","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /catalogue-tag-list","href":"/api-reference/coaching-catalogue/list-coaching-catalogue-directories"}]},{"group":"Results","pages":[{"title":"Get interview result details with transcript","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /job-interview-details","href":"/api-reference/results/get-interview-result-details-with-transcript"},{"title":"Generate an interview report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pdf","href":"/api-reference/results/generate-an-interview-report"},{"title":"Request another interview attempt","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-result-request-another-attempt","href":"/api-reference/results/request-another-interview-attempt"},{"title":"Record an external assessment result","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /assessment-result-set","href":"/api-reference/results/record-an-external-assessment-result"},{"title":"List interview results","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-result-list","href":"/api-reference/results/list-interview-results"},{"title":"Get daily event analytics","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-analytics","href":"/api-reference/results/get-daily-event-analytics"},{"title":"Get merchant credit usage","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-analytics-credits-used","href":"/api-reference/results/get-merchant-credit-usage"}]},{"group":"Reports","pages":[{"title":"List report datasets, fields and measures","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-catalog","href":"/api-reference/reports/list-report-datasets-fields-and-measures"},{"title":"List custom reports","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-list","href":"/api-reference/reports/list-custom-reports"},{"title":"Get a custom report definition","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-get","href":"/api-reference/reports/get-a-custom-report-definition"},{"title":"Run a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-run","href":"/api-reference/reports/run-a-custom-report"},{"title":"Check and run an unsaved report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-preview","href":"/api-reference/reports/check-and-run-an-unsaved-report"},{"title":"Create a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-create","href":"/api-reference/reports/create-a-custom-report"},{"title":"Update a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-update","href":"/api-reference/reports/update-a-custom-report"}]},{"group":"Candidates","pages":[{"title":"List candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-list","href":"/api-reference/candidates/list-candidates"},{"title":"Get a candidate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-get","href":"/api-reference/candidates/get-a-candidate"},{"title":"Add a note to a candidate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-note-add","href":"/api-reference/candidates/add-a-note-to-a-candidate"},{"title":"Tag candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-tags-set","href":"/api-reference/candidates/tag-candidates"},{"title":"Create, change or delete a candidate tag","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-tag-manage","href":"/api-reference/candidates/create-change-or-delete-a-candidate-tag"},{"title":"List candidate filter options","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-filter-options","href":"/api-reference/candidates/list-candidate-filter-options"},{"title":"Preview merging two candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-merge-preview","href":"/api-reference/candidates/preview-merging-two-candidates"},{"title":"Merge two candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-merge","href":"/api-reference/candidates/merge-two-candidates"},{"title":"Dismiss a possible duplicate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-duplicate-dismiss","href":"/api-reference/candidates/dismiss-a-possible-duplicate"},{"title":"List candidate segments","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-segment-list","href":"/api-reference/candidates/list-candidate-segments"},{"title":"Create, change or delete a candidate segment","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-segment-manage","href":"/api-reference/candidates/create-change-or-delete-a-candidate-segment"},{"title":"Download a candidate document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-document-download","href":"/api-reference/candidates/download-a-candidate-document"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-task-list","href":"/api-reference/tasks/list-tasks"},{"title":"Create or change a task","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-task-save","href":"/api-reference/tasks/create-or-change-a-task"}]},{"group":"Document requests","pages":[{"title":"List document requests","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-document-request-list","href":"/api-reference/document-requests/list-document-requests"},{"title":"Ask a candidate for documents","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-document-request-create","href":"/api-reference/document-requests/ask-a-candidate-for-documents"},{"title":"Cancel a document request or mark it reviewed","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-document-request-update","href":"/api-reference/document-requests/cancel-a-document-request-or-mark-it-reviewed"}]},{"group":"Reasons","pages":[{"title":"List the company's reasons","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-reason-list","href":"/api-reference/reasons/list-the-companys-reasons"},{"title":"Get one of the company's reasons","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-reason-get","href":"/api-reference/reasons/get-one-of-the-companys-reasons"},{"title":"Create, change or archive a reason","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-reason-save","href":"/api-reference/reasons/create-change-or-archive-a-reason"}]},{"group":"Knowledge base","pages":[{"title":"Upload a knowledge base document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-document-upload","href":"/api-reference/knowledge-base/upload-a-knowledge-base-document"},{"title":"List knowledge base documents and their interview limits","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /knowledge-base-document-list","href":"/api-reference/knowledge-base/list-knowledge-base-documents-and-their-interview-limits"},{"title":"Change which interviews can use a document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-document-set-interviews","href":"/api-reference/knowledge-base/change-which-interviews-can-use-a-document"},{"title":"List knowledge base stores","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /knowledge-base-store-list","href":"/api-reference/knowledge-base/list-knowledge-base-stores"},{"title":"Create or change a knowledge base store","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-store-save","href":"/api-reference/knowledge-base/create-or-change-a-knowledge-base-store"}]},{"group":"Resume \u0026 Form verification","pages":[{"title":"Create or update a pre-screening position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /pre-screening-create","href":"/api-reference/resume-\u0026-form-verification/create-or-update-a-pre-screening-position"},{"title":"Run pre-screening on a plaintext resume","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pre-screening-api-resume-text","href":"/api-reference/resume-\u0026-form-verification/run-pre-screening-on-a-plaintext-resume"},{"title":"Pre-screen a candidate from a binary resume upload","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pre-screening-api-resume-binary","href":"/api-reference/resume-\u0026-form-verification/pre-screen-a-candidate-from-a-binary-resume-upload"}]},{"group":"Admin","pages":[{"title":"Invite admin / merchant-team or coaching users","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /invite-users","href":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users"},{"title":"List sub-merchants","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-sub-merchant-list","href":"/api-reference/admin/list-sub-merchants"},{"title":"List the company's users","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-user-list","href":"/api-reference/admin/list-the-companys-users"},{"title":"List avatar templates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-avatar-list","href":"/api-reference/admin/list-avatar-templates"},{"title":"Get merchant status","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-status","href":"/api-reference/admin/get-merchant-status"},{"title":"List platform languages","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /platform-languages-list","href":"/api-reference/admin/list-platform-languages"},{"title":"Get the portal configuration (branding, portals, brands, pages)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /portal-configuration-get","href":"/api-reference/admin/get-the-portal-configuration-branding-portals-brands-pages"},{"title":"Update the portal configuration (branding, portals, brands, pages)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-configuration-update","href":"/api-reference/admin/update-the-portal-configuration-branding-portals-brands-pages"},{"title":"Publish a brand stylesheet","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-css-publish","href":"/api-reference/admin/publish-a-brand-stylesheet"},{"title":"Get the component style guide","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /portal-component-styles","href":"/api-reference/admin/get-the-component-style-guide"},{"title":"Save a component style","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-component-styles","href":"/api-reference/admin/save-a-component-style"},{"title":"Generate component style alternatives","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-component-styles-generate","href":"/api-reference/admin/generate-component-style-alternatives"},{"title":"List the media library","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /media-list","href":"/api-reference/admin/list-the-media-library"},{"title":"Start uploading a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-upload-start","href":"/api-reference/admin/start-uploading-a-media-file"},{"title":"Finish uploading a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-upload-finish","href":"/api-reference/admin/finish-uploading-a-media-file"},{"title":"Describe a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-update","href":"/api-reference/admin/describe-a-media-file"},{"title":"Delete a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-delete","href":"/api-reference/admin/delete-a-media-file"},{"title":"List the media library folders","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /media-folders","href":"/api-reference/admin/list-the-media-library-folders"},{"title":"Create, rename or delete a media library folder","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-folders","href":"/api-reference/admin/create-rename-or-delete-a-media-library-folder"}]},{"group":"Feedback","pages":[{"title":"Submit a feature request","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-feature-request","href":"/api-reference/feedback/submit-a-feature-request"},{"title":"Report a technical issue","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-technical-issue","href":"/api-reference/feedback/report-a-technical-issue"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/interview-result-submitted"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Update an interview or position - JobMojito Developer / Agent","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}