Coaching portal - JobMojito Developer / Agent

Coaching portal configuration

Generates the document imported by Configuration → Branding & Configuration → Import configuration → Coaching portal. This is the largest of the three documents: it covers the portal’s vertical, its feature toggles, its coaching plan, and the home content for every language. Every field is optional: omitted fields keep their current value, and so do null and empty strings (an import cannot clear a field). Languages are only ever added, never removed, so an import cannot delete existing translated content. Every pages[].language is enabled too, even when languages does not list it. The import dialog checks the document first (a dry run) and lists what will change. Apply then saves everything at once: the portal fields straight to the portal, the built-in page content as drafts. Apply is blocked while Branding & Configuration has unsaved changes of its own. The same document can also be sent through the API or MCP.

Since the Pages editor (Configuration → Consumer portal), the support page and the signed-in home are built-in pages. This import still accepts support_page_markdown and signed_in_home_blocks, but writes them into those pages’ drafts (see Where each field goes). For additional pages, a menu, a site footer or a theme, use the portal pages import.

Document

{
  "kind": "coaching-portal",
  "version": 1,

  "use_case": "simulation",

  "features": {
    "interview_coach_enabled": true,
    "resume_check_enabled": false,
    "cover_letter_enabled": false,
    "trivia_enabled": false,
    "homepage_pricing_enabled": false,
    "purchase_credits_enabled": false
  },

  "labels": {
    "catalogue": "Case library",
    "sessions": "Simulations",
    "plan": "Placement plan",
    "session-singular": "patient simulation",
    "session-plural": "patient simulations",
    "coach": "Simulated patient"
  },

  "coaching_plan_tags": ["osce-basics-en", "osce-cardiology-en"],
  "catalogue_start_tag": "osce-home-en",

  "languages": ["en"],

  "pages": [
    {
      "language": "en",
      "public_home_blocks": [
        {
          "id": "hero",
          "type": "hero",
          "kicker": "Clinical simulation",
          "title": "# Practise with _real_ patients, safely",
          "body": "Talk to an AI patient, get scored, repeat until it is second nature.",
          "ctaLabel": "Start training",
          "ctaHref": "/home"
        },
        {
          "id": "stats",
          "type": "stats",
          "items": [
            { "value": "120", "label": "Case scenarios" },
            { "value": "24/7", "label": "Available" }
          ]
        }
      ],
      "signed_in_home_blocks": [
        {
          "id": "notice",
          "type": "rich-text",
          "body": "Start with the cardiology cases before Thursday's assessment.",
          "boxed": true
        }
      ],
      "support_page_markdown": "## Getting help\n\nContact simulation@example.org."
    }
  ]
}

kind is optional, but when present it must be "coaching-portal"; a document declaring another kind is refused.

Top-level fields

Field	Type	Notes
`use_case`	enum	`job-seeker`, `corporate`, `simulation`, `education`, `custom`. Sets the default wording everywhere. Rejected if any other value. Unlike the Portal type dropdown in the admin, it does not switch the features to the use case’s defaults: list them in `features`.
`features.*`	boolean	Only the six keys above are recognised; anything else is reported as ignored.
`labels.*`	string	Overrides the preset wording. Only the six keys above are recognised.
`coaching_plan_tags`	string[]	Ordered `catalogue_tag` ids. See the warning below.
`catalogue_start_tag`	string	The directory the catalogue opens on.
`languages`	string[]	Language codes to enable. A portal with no languages stored counts as `["en"]`.
`pages[]`	object[]	Per-language content, keyed by `language`; entries without it are skipped.

use_case and labels

use_case picks a vocabulary preset; labels overrides individual words on top of it. Prefer the preset and override only where the organisation genuinely uses different terminology. Overrides are portal-wide, not per language, so if the portal runs several languages, either leave labels out and let the preset translate, or accept that the override text appears in every language.

coaching_plan_tags: must be live directories

A directory only reaches learners when it is visibility: public and status: active. A plan step pointing at a draft or archived directory is silently dropped from the plan: the learner sees a shorter plan with no explanation. Only reference directories you have confirmed exist and are active (see Build a coaching catalogue). If you cannot confirm, leave coaching_plan_tags out entirely: with no plan configured the block is hidden rather than shown half-empty.

Where each field goes

Fields	Goes to	Saved
`use_case`, `features`, `labels`, `coaching_plan_tags`, `catalogue_start_tag`, `languages`	The coaching portal settings.	At once, on Apply.
`public_home_blocks`	The signed-out home page (`/`), while no home page is published in Pages	At once, on Apply. The Coaching portal tab no longer edits home content, so the dialog’s summary is the only review.
`support_page_markdown`	Built-in page `_support` (`/support`)	Immediately, as a draft. The text becomes one text block of that language, replacing that language’s blocks (and its SEO description); other languages stay. Nothing is published: the operator publishes it from Pages.
`signed_in_home_blocks`	Built-in page `_signed_in_home` (top of `/home`)	Same as above; the blocks replace that language’s blocks.

Page blocks

public_home_blocks renders the signed-out marketing home page. signed_in_home_blocks renders at the top of /home after sign-in; keep that one short, it sits above the learner’s coaching. Once a home page (slug "") is published in Pages, it replaces public_home_blocks: importing them afterwards changes nothing a visitor sees. For a customised home page, import the page itself with the portal pages import. Each block needs a type and should carry an id, unique within its list and stable between imports (a missing id is generated as <type>-<index>-imported). A block with an unknown type is skipped and reported; the rest of the import still applies. This document accepts the ten home-page block types below; the portal pages import accepts more (cards, tabs, video, …). Every block may also carry enabled (false hides it), tone (default, muted, dark, accent: the section background), anchor (id for /#anchor links) and className (hook for a theme).

type	Fields
`hero`	`kicker`, `title` (markdown), `body` (markdown), `ctaLabel`, `ctaHref`, `imageUrl`, `layout` (`split`\|`background`), `align` (`left`\|`center`), `height` (`medium`\|`tall`), `videoUrl`
`stats`	`title`, `items[]` of `{ value, label }`
`media-text`	`title`, `body` (markdown), `imageUrl`, `imageSide` (`left`\|`right`), `ctaLabel`, `ctaHref`
`feature-grid`	`title`, `columns` (2–5), `imageStyle` (`cover`\|`icon`), `items[]` of `{ title, body, imageUrl, href, linkLabel }`
`quote`	`quote`, `author`, `role`, `imageUrl`, `layout` (`centered`\|`photo`), `title`
`logo-row`	`title`, `layout` (`row`\|`slider`), `logos[]` of `{ imageUrl, alt }`
`rich-text`	`body` (markdown), `width` (`narrow`\|`wide`), `boxed` (boolean), `textStyle` (`headline`\|`body`)
`pricing`	`title`; renders the configured pricing table
`cta`	`title`, `body` (markdown), `ctaLabel`, `ctaHref`, `imageUrl` (background photo), `align` (`center`\|`left`)
`faq`	`title`, `items[]` of `{ question, answer }`

Markdown fields are rendered with a restricted renderer: headings, bold, italic, lists, links (see Format content with Markdown). In a hero title, wrapping a word in _underscores_ renders it as the italic accent word. Images must be URLs that are already hosted. The importer uploads nothing.

Import through the API or MCP

Send the document in documents of POST /portal-configuration-update with "kind": "coaching-portal", first with "dry_run": true to see what would change, then with false to apply. GET /portal-configuration-get?sections=coaching-portal returns the current document to edit and send back. It leaves out the built-in page texts: read and change _support and _signed_in_home in the coaching-pages document instead, with the portal pages import. The MCP tools are get_portal_configuration and update_portal_configuration. publish does not apply here: the built-in page drafts are never published by an import. The request fields and a curl example are on the Branding page.

Rules

Put the primary language first in pages[].
Blocks render in array order; that order is the page.
A hero ctaHref of /home sends a signed-out visitor into sign-up. Use that unless there is a reason not to.
homepage_pricing_enabled shows the Pricing link in the header (and a pricing section on a home page that has no blocks yet). A pricing block always renders the price table, so add one, or switch the link on, only when the portal actually sells credits.
Tell the operator that the support page and the signed-in home land as drafts in Pages and need publishing there.

​Coaching portal configuration

​Document

​Top-level fields

​use_case and labels

​coaching_plan_tags: must be live directories

​Where each field goes

​Page blocks

​Import through the API or MCP

​Rules

Coaching portal configuration

Document

Top-level fields

use_case and labels

coaching_plan_tags: must be live directories

Where each field goes

Page blocks

Import through the API or MCP

Rules