create_catalogue_directory

{
  "type": "object",
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "pattern": "^[a-z0-9]+(?:(?:-|_)+[a-z0-9]+)*$",
      "description": "Directory id — also the catalogue URL segment (/catalogue/<id>) and the value other directories reference in their `tags_sub`. Lowercase letters, digits and single - or _ separators. Convention is to end language-specific directories with the language code, e.g. `sales-coaching-en`.",
      "example": "sales-coaching-en"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "description": "Display name of the directory, shown as the page title and on its card.",
      "example": "Sales coaching"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Short description shown on the directory card.",
      "example": "Practice discovery, objection handling and closing."
    },
    "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",
        null
      ],
      "description": "Language of the directory (one of the platform-languages.json codes). The catalogue groups directories by language; defaults to `en` when omitted.",
      "example": "en"
    },
    "visibility": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "public",
        "merchant_public",
        "merchant_invite",
        "merchant_unlisted",
        null
      ],
      "description": "Who can see the catalogue directory. Options — `public`: Shared across every merchant. Platform admins only — a merchant caller is rejected by row-level security. | `merchant_public`: Listed in the merchant's own catalogue — the normal choice. | `merchant_invite`: Owned by the merchant but not listed; reachable only for invited users. | `merchant_unlisted`: Owned by the merchant but not listed; reachable only via a direct link..",
      "example": "merchant_public"
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "draft",
        "active",
        "archived",
        null
      ],
      "description": "Lifecycle status of the catalogue directory. Options — `draft`: Not published — the directory exists but is not served to visitors. | `active`: Published and served in the catalogue. | `archived`: Retired — kept for reference but no longer served..",
      "example": "active"
    },
    "cover_image_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cover image URL shown on the directory card."
    },
    "coach_plan": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "demo",
        "screening",
        "2nd",
        "3rd",
        "closing",
        "job-specific",
        "other",
        null
      ],
      "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"
    },
    "tags_sub": {
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ],
      "description": "Ids of the directories nested under this one, in display order. Replaces the whole list — send the full set, not just the additions. A referenced directory only appears if it exists and is visible to the viewer.",
      "example": [
        "sales-coaching-objections-en",
        "sales-coaching-closing-en"
      ]
    },
    "tags_interview_set_filter": {
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ],
      "description": "Tag filter selecting which coaching sessions this directory lists: a session appears when its own `tags` contain EVERY tag here (an AND, not an OR). Only `active` coaching/persona sessions with visibility `public` or `merchant_public` are listed. Set the matching tags on the session with the create-interview / job-interview-update `tags` field.",
      "example": [
        "sales",
        "objection-handling"
      ]
    },
    "content_md": {
      "type": [
        "string",
        "null"
      ],
      "description": "Markdown for a custom directory page. When set (even as an empty string) the markdown replaces the default grid and decides the layout itself; null renders the plain grid of sub-directories and sessions. Alongside normal Markdown you can place these directives, each ALONE on its own line: `[plan-progress]` (the learner's coaching-plan progress), `[directory:<tag-id>]` (a card for one sub-directory), `[session:<interview-id>]` (a card for one session), `[sessions]` (every session in this directory), `[sessions:<term>]` (sessions matching a term), `[sessions:filter=<term>,limit=<n>]` (a filtered, capped list). A directive on a line with other text is rendered as ordinary text. Chips, callouts, cards, columns and buttons are available here too — full vocabulary: https://developer.jobmojito.com/cookbooks/format-content-with-markdown",
      "example": "## Sales coaching\n\nPick a session to practise with.\n\n[chip:6 sessions] [chip:Beginner,tone=accent]\n\n[sessions:filter=objection-handling,limit=6]\n"
    },
    "parent_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "Id of an existing directory to nest this new one under: the new id is appended to that directory's `tags_sub`. Omit to create a top-level directory (reachable via a direct link, or by adding it to another directory later).",
      "example": "home-employee-en"
    },
    "merchant_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Merchant that owns the directory. Admin / sub-merchant callers only; otherwise taken from your token.",
      "example": "28106cba-1c27-4e53-b149-32113e5e8e31"
    }
  },
  "required": [
    "id",
    "name"
  ]
}