JobMojito · Schema
JobInterviewUpdateRequest
Artificial IntelligenceInterviewRecruitingSoftware-as-a-ServiceHiring
Properties
| Name | Type | Description |
|---|---|---|
| position_id | string | Id of the interview definition (single-stage) or position definition (multi-stage) to update. The same id you pass to job-interview-get. |
| status | 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 |
| visibility | 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 inte |
| environment | 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 |
| name | stringnull | Interview / position name. |
| code | stringnull | External code/reference. Blank is stored as null. |
| location | stringnull | Interview location. Blank is stored as null. |
| cover_image_url | stringnull | Cover image URL. |
| description | stringnull | Short interview description. |
| description_long | stringnull | 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/c |
| interview_department | stringnull | Department the position belongs to. Blank is stored as null. |
| interview_salary | stringnull | Salary range shown for the position. Blank is stored as null. |
| interview_available_till | stringnull | ISO date/time after which the interview is no longer available to candidates. null keeps it always available. |
| recruiter_profile_id | stringnull | 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 |
| candidate_notification_channel | stringnull | 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" = inv |
| country_availability | objectnull | 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_al |
| tags | arraynull | 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 pers |
| interview_category | stringnull | Job category shown on public listings above the department (free text), e.g. "Ashore". Interviews and positions. Blank is stored as null. |
| emoji | stringnull | Emoji marker shown in the admin lists. Interviews and positions. Blank is stored as null. |
| collect_resume_cover_letter | string | Ask the candidate for a resume / cover letter: hidden, optional or required. Single-stage interviews only. |
| 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 | array | 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. N |
| custom_fields | object | 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 dat |
| questions | array | 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 |
| 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 `que |
| type | 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 inter |
| type_credit | stringnull | 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`: Resu |
| coach_plan | stringnull | 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. | |
| 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. |
| knowledge_base_store_id | stringnull | Knowledge base store id the interview draws context from; validated for existence. null unlinks it. |
| recording | stringnull | 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 do |
| recording_full_session | stringnull | 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). Option |
| result_view | 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 transcri |
| candidate_video_introduction | stringnull | Whether a candidate video introduction is hidden, optional or required. null is treated like hidden. |
| interview_conversation_speed | stringnull | 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 speakin |
| max_followups | integernull | 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). |
| max_duration | numbernull | Live session limit in seconds. Also the basis for the credit multiplier. |
| questions_random_subset | numbernull | Ask only a random subset of the questions, as a fraction between 0.01 and 0.9. null asks all questions. |
| interview_attempts | number | Allowed candidate attempts (1-20). Stored as result_scoring.max_retries. |
| required_pronunciation | booleannull | Require pronunciation assessment (restricts to pronunciation-capable languages). |
| result_enable_edit_transcript | booleannull | Allow editing the transcript on the result view. |
| candidate_expectations | stringnull | Free-text candidate expectations. |
| candidate_expectations_json | objectnull | Structured candidate expectations (the scoring rubric), bucketed by requirement level (weak/moderate/strong). null clears the rubric. Extra keys are preserved. |
| custom_scoring | objectnull | 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 config |
| pdf_export_auto_config | objectnull | Auto-generate a candidate PDF report with these options once the interview completes. null disables auto-export. |
| interview_type | stringnull | 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-screenin |
| interview_tone | stringnull | 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 cur |
| seniority_level | stringnull | 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 professi |
| hiring_for_company | objectnull | 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: ' |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/jobmojito-com/json-schema/jobmojito-com-job-interview-update-request-schema.json",
"title": "JobInterviewUpdateRequest",
"x-generated": "2026-11-13",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/jobmojito-com-openapi.json#/components/schemas/JobInterviewUpdateRequest",
"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."
},
"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."
},
"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."
},
"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."
},
"name": {
"type": [
"string",
"null"
],
"description": "Interview / position name."
},
"code": {
"type": [
"string",
"null"
],
"description": "External code/reference. Blank is stored as null."
},
"location": {
"type": [
"string",
"null"
],
"description": "Interview location. Blank is stored as null."
},
"cover_image_url": {
"type": [
"string",
"null"
],
"description": "Cover image URL."
},
"description": {
"type": [
"string",
"null"
],
"description": "Short interview description."
},
"description_long": {
"type": [
"string",
"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"
},
"interview_department": {
"type": [
"string",
"null"
],
"description": "Department the position belongs to. Blank is stored as null."
},
"interview_salary": {
"type": [
"string",
"null"
],
"description": "Salary range shown for the position. Blank is stored as null."
},
"interview_available_till": {
"type": [
"string",
"null"
],
"description": "ISO date/time after which the interview is no longer available to candidates. null keeps it always available."
},
"recruiter_profile_id": {
"type": [
"string",
"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."
},
"candidate_notification_channel": {
"type": [
"string",
"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."
},
"country_availability": {
"type": [
"object",
"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)."
},
"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."
},
"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."
},
"tags": {
"type": [
"array",
"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."
},
"interview_category": {
"type": [
"string",
"null"
],
"description": "Job category shown on public listings above the department (free text), e.g. \"Ashore\". Interviews and positions. Blank is stored as null."
},
"emoji": {
"type": [
"string",
"null"
],
"description": "Emoji marker shown in the admin lists. Interviews and positions. Blank is stored as 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."
},
"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)."
},
"team": {
"type": "array",
"items": {
"type": "object",
"properties": {
"profile_id": {
"type": "string",
"format": "uuid",
"description": "A person: an active or invited staff user of the company (profile.id)."
},
"profile_group_id": {
"type": "string",
"format": "uuid",
"description": "A group of the company (profile_group.id)."
},
"role": {
"type": "string",
"enum": [
"recruiter",
"sourcer",
"coordinator",
"hiring_manager",
"interviewer"
],
"description": "Role on the hiring team."
}
},
"required": [
"role"
]
},
"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`."
},
"custom_fields": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"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."
},
"questions": {
"type": "array",
"items": {
"$ref": "#/$defs/JobInterviewCreateFromArrayQuestion"
},
"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."
},
"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)."
},
"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."
},
"type_credit": {
"type": [
"string",
"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."
},
"coach_plan": {
"type": [
"string",
"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."
},
"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."
},
"knowledge_base_store_id": {
"type": [
"string",
"null"
],
"description": "Knowledge base store id the interview draws context from; validated for existence. null unlinks it."
},
"recording": {
"type": [
"string",
"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."
},
"recording_full_session": {
"type": [
"string",
"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."
},
"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."
},
"candidate_video_introduction": {
"type": [
"string",
"null"
],
"enum": [
"hidden",
"optional",
"required"
],
"description": "Whether a candidate video introduction is hidden, optional or required. null is treated like hidden."
},
"interview_conversation_speed": {
"type": [
"string",
"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."
},
"max_followups": {
"type": [
"integer",
"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)."
},
"max_duration": {
"type": [
"number",
"null"
],
"description": "Live session limit in seconds. Also the basis for the credit multiplier."
},
"questions_random_subset": {
"type": [
"number",
"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."
},
"interview_attempts": {
"type": "number",
"minimum": 1,
"maximum": 20,
"description": "Allowed candidate attempts (1-20). Stored as result_scoring.max_retries."
},
"required_pronunciation": {
"type": [
"boolean",
"null"
],
"description": "Require pronunciation assessment (restricts to pronunciation-capable languages)."
},
"result_enable_edit_transcript": {
"type": [
"boolean",
"null"
],
"description": "Allow editing the transcript on the result view."
},
"candidate_expectations": {
"type": [
"string",
"null"
],
"description": "Free-text candidate expectations."
},
"candidate_expectations_json": {
"type": [
"object",
"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."
},
"custom_scoring": {
"type": [
"object",
"null"
],
"additionalProperties": {
"nullable": true
},
"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."
},
"pdf_export_auto_config": {
"type": [
"object",
"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)."
},
"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."
},
"interview_type": {
"type": [
"string",
"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."
},
"interview_tone": {
"type": [
"string",
"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."
},
"seniority_level": {
"type": [
"string",
"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."
},
"hiring_for_company": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "End-employer name. Omit/null when hiring for yourself, 'undisclosed' for an unnamed external client, or the client's company name."
},
"description": {
"type": [
"string",
"null"
],
"description": "Short description of the end employer, used as background context by the agent."
},
"location": {
"type": [
"string",
"null"
],
"description": "Primary location of the end employer."
},
"sector": {
"type": [
"string",
"null"
],
"description": "Industry / sector of the end employer."
},
"company_size": {
"type": [
"string",
"null"
],
"description": "Approximate headcount of the end employer."
}
},
"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: '<company>' } plus optional description/location/sector/company_size. Stored in creation_parameters.hiring_for_company."
}
},
"required": [
"position_id"
],
"$defs": {
"JobInterviewCreateFromArrayQuestion": {
"type": "object",
"properties": {
"question": {
"type": "string",
"description": "The question text shown to the candidate."
},
"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."
},
"duration": {
"type": [
"number",
"null"
],
"description": "Answer duration in seconds for this question."
},
"mojito_language_code": {
"type": [
"string",
"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."
},
"label": {
"type": [
"string",
"null"
],
"description": "Optional label/tag stored on the question."
},
"is_conditional": {
"type": [
"boolean",
"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."
},
"is_without_scoring": {
"type": [
"boolean",
"null"
],
"description": "Question is asked but not scored (view 'without scoring')."
},
"is_candidate_asking_recruiter": {
"type": [
"boolean",
"null"
],
"description": "Candidate-asks-recruiter prompt (view 'candidate asking recruiter')."
},
"is_expert": {
"type": [
"boolean",
"null"
],
"description": "Expert listening question (view 'with listening expert')."
},
"is_multiple_choice": {
"type": [
"boolean",
"null"
],
"description": "Multiple-choice question (view 'multiple choice')."
},
"question_alternatives": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Alternative phrasings for the question."
},
"conditional_question_main_id": {
"type": [
"string",
"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."
},
"conditional_question_answer": {
"type": [
"boolean",
"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
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/jobmojito-com/json-schema/jobmojito-com-job-interview-update-request-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/jobmojito-com-job-interview-update-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.