> ## Documentation Index > Fetch the complete documentation index at: https://developer.jobmojito.com/llms.txt > Use this file to discover all available pages before exploring further. # Update the portal configuration (branding, portals, pages) > Imports portal configuration documents in one call: **branding** (portal name, style, colours, logos, e-mail sender name, speech term boosting), the **interview portal** (languages, home texts, support / application-tracking / interview-completed texts), the **coaching portal** (vertical, feature toggles, labels, coaching plan, catalogue start directory, languages, home blocks) and **portal sites** (pages in every language with their blocks, menu, footer and the theme CSS). Document formats: https://developer.jobmojito.com/cookbooks/portal-branding/branding, https://developer.jobmojito.com/cookbooks/portal-branding/interview-portal, https://developer.jobmojito.com/cookbooks/portal-branding/coaching-portal, https://developer.jobmojito.com/cookbooks/portal-branding/portal-pages. Read the current configuration with portal-configuration-get first: it returns these same documents, so you can edit them and send them back. Fields a document omits keep their value. Run with `dry_run: true` to preview the summary, warnings and changes, then repeat without it to apply. Validation is all-or-nothing: if any document has an error nothing is written and the 422 lists every error. Pages land as drafts unless `publish` is true; the support / tracking / completion / signed-in home texts of the portal documents always land as drafts of those built-in pages. ## OpenAPI ````yaml https://cool.jobmojito.com/functions/v1/openapi post /portal-configuration-update openapi: 3.1.0 info: title: JobMojito API version: 1.0.0 description: >- Public API for JobMojito, served by Supabase Edge Functions. Authenticate with a Supabase JWT access token via the Authorization header. servers: - url: https://cool.jobmojito.com/functions/v1 description: Production security: [] tags: - name: Interviews description: >- Create, configure and manage interview / coaching / assessment definitions. - name: Coaching catalogue description: >- Directories (pages) of the coaching portal catalogue that group coaching sessions and carry custom content pages. - name: Results description: >- Interview results, transcripts, reports, re-attempt requests and analytics. - name: Reports description: >- Custom reports: read the catalogue of datasets, build a report definition, check it, save it and run it. - name: Candidates description: List and manage candidates. - name: Knowledge base description: Upload documents used to generate knowledge-base interviews. - name: Resume & Form verification description: Pre-screen candidates from resumes and forms. - name: Admin description: >- Account administration — invite team/coaching users, manage sub-merchants and avatar templates. - name: Feedback description: >- Send feature requests to the product team and report technical issues to support. - name: Integrations description: >- Ready-made connectors and how their fields map to JobMojito. A company sees the same tables under Integrations > Catalogue > Field mapping. ### ATS connector (Kombo) The applicant tracking system is connected through Kombo's unified ATS API. JobMojito keeps a copy of the ATS jobs, applications and candidates, links each position to one ATS job, invites applicants who reach the trigger stage, and writes the outcome back. Links, notes and attachments are written only when the company switched them on (merchant.kombo_selected_result_actions); job fields are not copied into the position. | JobMojito field | Direction | External field | Notes | | --- | --- | --- | --- | | `merchant.kombo_integration_id, merchant.kombo_integration_tool` | Into JobMojito | `integration-created / integration-deleted webhook: data.id, data.tool` | Set when the ATS connection is created and cleared when it is deleted. | | `kombo_jobs.id, kombo_jobs.name` | Into JobMojito | `GET /ats/jobs: id, name (fallback title)` | Copied on every full or incremental sync of the jobs. | | `kombo_jobs.status` | Into JobMojito | `jobs.status, jobs.remote_deleted_at` | DRAFT becomes draft, CLOSED or ARCHIVED becomes archived, deleted in the ATS becomes deleted. | | `kombo_jobs.data` | Into JobMojito | `jobs.* (whole job object)` | Kept as received; the position's own fields are not overwritten from it. | | `position_def_set.kombo_parameters.kombo_job_id, interview_def_set.kombo_parameters.kombo_job_id` | Into JobMojito | `jobs.id` | Links a position or interview to one ATS job, chosen by the recruiter. | | `position_def_set.status, interview_def_set.status` | Into JobMojito | `jobs.status (closed, archived, deleted, reopened)` | Closing the job in the ATS archives the linked positions and interviews; reopening it restores their previous status. | | `kombo_parameters.kombo_stage_id` | Into JobMojito | `jobs.stages[].id matched against applications.current_stage_id` | An application entering this stage triggers the invitation or the pre-screening; applicants already in it are invited when the position is published. | | `ATS pipeline report (stage names and order)` | Into JobMojito | `jobs.stages[].id, name, index` | Read for the ATS pipeline report only. | | `kombo_applications.id, kombo_job_id, kombo_candidate_id, data` | Into JobMojito | `GET /ats/applications: id, job_id, candidate_id` | Copied on application sync; applications of closed or archived jobs are not imported. | | `kombo_applications.kombo_stage_id` | Into JobMojito | `applications.current_stage_id` | A stage change re-runs the invitation check for that application. | | `kombo_applications.status` | Into JobMojito | `applications.outcome (HIRED, DECLINED), remote_deleted_at` | Hired, declined or deleted applications are archived and receive no further invitations. | | `position_result.outcome, interview_result.outcome` | Into JobMojito | `applications.outcome` | Set to hired or declined when the ATS marks the linked application, while the outcome is still pending. | | `position_result.status, interview_result.status` | Into JobMojito | `applications.remote_deleted_at` | An application deleted in the ATS archives the linked application in JobMojito if nobody has decided yet. | | `kombo_candidates.id, data, status` | Into JobMojito | `GET /ats/candidates: candidates.*, remote_deleted_at` | Copied on candidate sync; a candidate deleted in the ATS is archived. | | `profile_interview.email, profile_interview.email_auth` | Into JobMojito | `candidates.email_addresses[0].email_address` | Finds or creates the candidate when the application reaches the trigger stage. | | `profile_interview.name` | Into JobMojito | `candidates.first_name + last_name` | Set when the candidate is created from the ATS. | | `profile_interview.phone_number` | Into JobMojito | `candidates.phone_numbers[0].phone_number` | Set when the candidate is created from the ATS. | | `kombo_candidates.profile_interview_id` | Into JobMojito | `candidates.id (matched by e-mail)` | Links the ATS candidate to the JobMojito candidate on invitation or pre-screening. | | `interview_file (type resume)` | Into JobMojito | `GET /ats/applications/{id}/attachments, then /ats/candidates/{id}/attachments: type CV (fallback OTHER)` | The CV from the ATS is imported when the candidate is invited or pre-screened. | | `interview_result_pre_screening (AI pre-screening input)` | Into JobMojito | `applications.screening_question_answers[] (question.title, answer)` | The candidate's answers to the ATS screening questions are part of the AI pre-screening. | | `interview_result_pre_screening.nationality, residency` | Into JobMojito | `candidates.location.country (fallback address.country)` | Taken from the ATS candidate during pre-screening. | | `kombo_applications.interview_result_id, interview_result_pre_screening_id` | Into JobMojito | `applications.id` | Set when the candidate's result is linked back to the ATS application. | | `kombo_tags, kombo_rejection_reasons, kombo_users, kombo_offers, kombo_interviews` | Into JobMojito | `GET /ats/tags, /ats/rejection-reasons, /ats/users, /ats/offers, /ats/interviews` | Kept in sync so recruiters can pick tags and rejection reasons; the others are stored only. | | `kombo_parameters.kombo_selected_stage_id (step: config.kombo.accept_stage_id)` | From JobMojito | `PUT /ats/applications/{id}/stage` | Moves the application when the recruiter selects the candidate; the position's stage is used on the last step. | | `kombo_parameters.kombo_sync_all_results_stage_id` | From JobMojito | `PUT /ats/applications/{id}/stage` | Every processed result is moved to this stage, only when sync all results is on. | | `kombo_parameters.kombo_rejected_reason_human_id, kombo_rejected_reason_ai_id (step: config.kombo.reject_reason_id)` | From JobMojito | `POST /ats/applications/{id}/reject { rejection_reason_id, note }` | Rejects the application when the recruiter rejects; nothing is sent when no reason is configured. | | `Rejection note (result link, score, AI feedback)` | From JobMojito | `reject.note` | The note sent with the rejection. | | `interview_result result link + interview_result.score` | From JobMojito | `POST /ats/applications/{id}/result-links { label, url, details.attributes }` | Sent when result links are switched on: a signed link to the result with its score. | | `interview_result note (result link + score)` | From JobMojito | `POST /ats/applications/{id}/notes` | Sent when notes are switched on and the recruiter has decided, or sync all results is on. | | `interview_result.pdf_export_url (interview PDF report)` | From JobMojito | `POST /ats/applications/{id}/attachments (type OTHER)` | Sent when attachments are switched on; the PDF is generated first if missing. | | `interview_result_pre_screening score, recommendation and analysis` | From JobMojito | `POST /ats/applications/{id}/notes` | Sent after every AI pre-screening and again when the recruiter decides on it. | | `Pre-screening PDF report` | From JobMojito | `POST /ats/applications/{id}/attachments (type OTHER)` | Uploaded when attachments are switched on. | | `interview_result.coach_status (progress note)` | From JobMojito | `POST /ats/applications/{id}/notes` | A note when the interview fails or the answers are collected, only when sync all results is on. | | `position_result_step decision and recruiter notes (meeting step)` | From JobMojito | `POST notes, PUT stage, POST reject` | Sends ': passed / failed' with the recruiter's notes, then moves or rejects. | | `human_interview_request reason and outcome` | From JobMojito | `POST notes, PUT stage, POST reject` | Notes the request, moves on pass and rejects on fail or decline. | | `merchant.kombo_tag_assignment.result_weak / result_moderate / result_strong / result_exceptional` | From JobMojito | `POST /ats/candidates/{id}/tags` | Score tags on result sync: under 4 weak, under 7 moderate, under 8.5 strong, up to 10 exceptional. | | `merchant.kombo_tag_assignment.interview_selected / interview_rejected` | From JobMojito | `POST /ats/candidates/{id}/tags` | Decision tags on a recruiter decision; the selected tag only on the last step. | | `merchant.kombo_sync (manual sync)` | From JobMojito | `POST /force-sync` | Asks Kombo to sync the ATS again when the recruiter presses sync. | ### Webhooks JobMojito POSTs the same JSON payload for the events interview_result (the result is final and scored, sent again when a watched field changes), interview_collected (the candidate finished, before scoring) and interview_failed (failed, abandoned or no speech). Configure the URL, events and authentication headers per environment under Integrations > Custom integration; failed deliveries are retried and kept in the delivery history. | JobMojito field | Direction | External field | Notes | | --- | --- | --- | --- | | `interview_result.id` | From JobMojito | `id` | The result the event is about. | | `interview_result.question_set_id (interview_def_set.id)` | From JobMojito | `interview_id` | The interview definition. | | `interview_result.question_set_id (interview_def_set.id)` | From JobMojito | `question_set_id` | Same value as interview_id. | | `interview_result.status` | From JobMojito | `status` | active for interview_result, draft for the other two events. | | `interview_result.coach_status` | From JobMojito | `interview_status` | completed, failed, abandoned and so on. | | `interview_result.processing_status` | From JobMojito | `processing_status` | AI processing state. | | `interview_result.profile_interview_id` | From JobMojito | `profile_interview_id` | The candidate. | | `interview_result.profile_id` | From JobMojito | `profile_id` | The candidate's portal account, when there is one. | | `profile_interview.external_id` | From JobMojito | `candidate_external_id` | Your id for the candidate; present when a candidate is linked. | | `profile_interview.name` | From JobMojito | `candidate_name` | Present when a candidate is linked. | | `profile_interview.email` | From JobMojito | `candidate_email` | Present when a candidate is linked. | | `profile_interview.phone_number` | From JobMojito | `candidate_phone_number` | Present when a candidate is linked. | | `interview_result.recruiter_go_next_round` | From JobMojito | `recruiter_go_next_round` | The recruiter's decision; usually empty in interview_collected and interview_failed. | | `interview_result.ai_analysis` | From JobMojito | `ai_analysis` | Candidate-facing analysis, filled in interview_result. | | `interview_result.ai_analysis_recruiter` | From JobMojito | `ai_analysis_recruiter` | Recruiter-facing analysis, filled in interview_result. | | `interview_result.ai_analysis_other` | From JobMojito | `ai_analysis_other` | Session analyses by name, for example strengths_concerns. | | `interview_result.ai_analysis_other.strengths_concerns.strengths` | From JobMojito | `ai_analysis_recruiter_why_hire` | Deprecated copy kept for existing integrations. | | `interview_result.ai_analysis_other.strengths_concerns.concerns` | From JobMojito | `ai_analysis_recruiter_why_not_hire` | Deprecated copy kept for existing integrations. | | `interview_result.score_interview_ai` | From JobMojito | `ai_analysis_recruiter_score` | Recruiter-facing AI score, filled in interview_result. | | `interview_result.score` | From JobMojito | `score` | Overall score, filled in interview_result. | | `interview_result.pdf_export_url` | From JobMojito | `pdf_export_url` | When a PDF report is configured, interview_result waits until the PDF exists. | | `Changed fields of the result` | From JobMojito | `reason` | Which watched fields changed; 'manual re-trigger of ...' on a resend from the delivery history. | paths: /portal-configuration-update: post: tags: - Admin summary: Update the portal configuration (branding, portals, pages) description: >- Imports portal configuration documents in one call: **branding** (portal name, style, colours, logos, e-mail sender name, speech term boosting), the **interview portal** (languages, home texts, support / application-tracking / interview-completed texts), the **coaching portal** (vertical, feature toggles, labels, coaching plan, catalogue start directory, languages, home blocks) and **portal sites** (pages in every language with their blocks, menu, footer and the theme CSS). Document formats: https://developer.jobmojito.com/cookbooks/portal-branding/branding, https://developer.jobmojito.com/cookbooks/portal-branding/interview-portal, https://developer.jobmojito.com/cookbooks/portal-branding/coaching-portal, https://developer.jobmojito.com/cookbooks/portal-branding/portal-pages. Read the current configuration with portal-configuration-get first: it returns these same documents, so you can edit them and send them back. Fields a document omits keep their value. Run with `dry_run: true` to preview the summary, warnings and changes, then repeat without it to apply. Validation is all-or-nothing: if any document has an error nothing is written and the 422 lists every error. Pages land as drafts unless `publish` is true; the support / tracking / completion / signed-in home texts of the portal documents always land as drafts of those built-in pages. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PortalConfigurationUpdateRequest' responses: '200': description: Documents validated and (unless dry_run) applied. content: application/json: schema: $ref: '#/components/schemas/PortalConfigurationUpdateResponse' '401': description: Missing, expired or invalid access token. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Your token is not allowed to use this endpoint (it is not a merchant, merchant owner or admin token), or row-level security refused the write. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No merchant with this id (or not visible to you). content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- Validation error: the request is malformed, or at least one document has an error (all listed in `errors`). Nothing was written. content: application/json: schema: $ref: '#/components/schemas/PortalConfigurationValidationError' '500': description: >- Server error. When some writes succeeded before others failed, `failures` lists the failed writes and `applied` what was written. content: application/json: schema: $ref: '#/components/schemas/PortalConfigurationWriteError' security: - bearerAuth: [] components: schemas: PortalConfigurationUpdateRequest: type: object properties: merchant_id: type: string format: uuid description: >- Optional merchant to configure. Admins and sub-merchant operators only; other callers always use their token's merchant. example: 28106cba-1c27-4e53-b149-32113e5e8e31 documents: type: array items: $ref: '#/components/schemas/PortalConfigurationDocument' minItems: 1 maxItems: 20 description: >- 1 to 20 documents, applied in order (a later document wins where two set the same thing). Every field a document omits keeps its current value; languages are only ever added, never removed. kind: type: string enum: - branding - interview-portal - coaching-portal - portal-site description: >- Optional: lock the call to one document type, as one admin import tab does. Every document must then be that type (`portal-site` accepts both portal-site and portal-page formats), and a document that declares neither `kind` nor `format` is read as this type with a warning. Without it, every document must declare its own `kind` or `format`. portal: type: string enum: - interview - consumer description: >- Where portal-site pages and theme CSS go: `interview` (candidate-facing interview / careers portal) or `consumer` (coaching portal). Default: the portal-site document's own `portal`, else `interview`. A document made for the other portal is imported here with a warning. publish: type: boolean default: false description: >- Also publish the imported pages and theme CSS (live at once, as the admin's "Publish after import"). Default false: pages land as drafts the company reviews in the admin. Built-in page drafts produced by interview-portal / coaching-portal documents are never published. With page versions switched on, only a company owner or admin may publish. dry_run: type: boolean default: false description: >- Validate and report what would change (summary, warnings, changes) without writing anything. Use it to preview an import before applying it. required: - documents PortalConfigurationUpdateResponse: type: object properties: merchant_id: type: string description: Merchant that was configured. example: 28106cba-1c27-4e53-b149-32113e5e8e31 dry_run: type: boolean description: True when nothing was written. documents: type: array items: $ref: '#/components/schemas/PortalConfigurationDocumentReport' changes: $ref: '#/components/schemas/PortalConfigurationChanges' required: - merchant_id - dry_run - documents - changes Error: type: object properties: error: type: string example: Field is required. name: type: string example: interview_result_id required: - error PortalConfigurationValidationError: type: object properties: error: type: string description: The first problem, or a count. name: type: string example: documents errors: type: array items: type: string description: >- Every problem found, each prefixed with the document it is in. Nothing was written. example: - 'documents[0]: style must be "bold" or "minimal", got "dark".' - 'documents[1].pages[0]: slug "jobs" is not allowed (reserved)' required: - error PortalConfigurationWriteError: type: object properties: error: type: string name: type: string example: write failures: type: array items: type: string description: The writes that failed. applied: allOf: - $ref: '#/components/schemas/PortalConfigurationChanges' - description: What was written before / despite the failures. required: - error PortalConfigurationDocument: type: object properties: kind: type: string enum: - branding - interview-portal - coaching-portal description: >- Portal configuration document type. `branding`: portal name, style, colours, logos, e-mail sender name, speech term boosting. `interview-portal`: interview portal languages and the per-language home texts. `coaching-portal`: coaching portal vertical (`use_case`), feature toggles, label overrides, coaching plan, catalogue start directory, languages and per-language home blocks. A portal site document declares `format` instead. example: branding format: type: string enum: - jobmojito.portal-site - jobmojito.portal-page description: >- Portal site document type. `jobmojito.portal-site`: `{ portal, theme: { css }, pages: [Page] }`, a whole site (pages in every language, the menu, the footer and the theme CSS). `jobmojito.portal-page`: `{ page: Page }`, one page. Page = `{ slug, show_in_menu, sort_order, languages: [{ mojito_language_code, title, description, blocks }] }`; slug "" is the home page, "_footer", "_support", "_jobs" etc. are the built-in pages. example: jobmojito.portal-site version: nullable: true description: Document format version. Always 1. example: 1 description: >- One configuration document: declares either `kind` (branding, interview-portal, coaching-portal) or `format` (jobmojito.portal-site, jobmojito.portal-page), plus that type's fields. Field reference: branding https://developer.jobmojito.com/cookbooks/portal-branding/branding, interview portal https://developer.jobmojito.com/cookbooks/portal-branding/interview-portal, coaching portal https://developer.jobmojito.com/cookbooks/portal-branding/coaching-portal, portal pages https://developer.jobmojito.com/cookbooks/portal-branding/portal-pages. Unknown fields are ignored with a warning; wrong types and enum values are errors. additionalProperties: true PortalConfigurationDocumentReport: type: object properties: index: type: integer description: Position of the document in the request. example: 0 kind: type: string enum: - branding - interview-portal - coaching-portal - portal-site description: How the document was read. summary: type: array items: type: string description: >- What the document sets, in the lines the admin dialog shows ("+ /slug" a new page, "↻ /slug" a replaced one). example: - 3 colour(s) - style "minimal" - portal name warnings: type: array items: type: string description: >- Parts that were ignored or adjusted. Warnings never block the import. required: - index - kind - summary - warnings PortalConfigurationChanges: type: object properties: merchant_fields: type: array items: type: string description: >- Company settings that change: column names, with the key for the branding / feature jsonb and the language for home texts. example: - homepage_name - template_colors.c_primary - interview_homepage_texts.de pages_created: type: array items: type: string description: Slugs of pages created. example: - our-history pages_updated: type: array items: type: string description: Slugs of existing pages whose draft (or published version) changes. example: - about - _support pages_unchanged: type: array items: type: string description: >- Slugs of pages the documents carry that already hold the same content (not written). theme_css: type: boolean description: Whether the theme CSS changes. published: type: boolean description: Whether anything is published by this call. portal: type: string enum: - interview - consumer description: Portal the portal-site pages and theme CSS went to. page_changes: type: array items: $ref: '#/components/schemas/PortalConfigurationPageChange' description: >- Every page touched, with its portal (built-in page drafts from a coaching-portal document go to the consumer portal). required: - merchant_fields - pages_created - pages_updated - pages_unchanged - theme_css - published - portal - page_changes description: 'What changed (for a dry run: what would change).' PortalConfigurationPageChange: type: object properties: portal: type: string enum: - interview - consumer description: Portal of the page. slug: type: string description: Page slug ("" is the home page). action: type: string enum: - create - update - unchanged description: What happens to the page. published: type: boolean description: Whether this write publishes the page. required: - portal - slug - action - published securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Supabase JWT — `Authorization: Bearer `.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.