Update home page draft

Update home page draft

Updates the home page draft content in place. Only the supplied fields are updated; null or absent fields are left unchanged.

Cards workflow: read the current card list via GET /system-pages/home/content, modify the array as needed, and send the full updated array back. Cards that include an existing id are updated in place; cards without an id receive a new one automatically.

The live page is not affected until POST /system-pages/home/publish is called.

backgroundImageFileName: pass a path to a file that already exists in Storage (e.g. Storage/Branding/bg.jpg), an empty string to remove the background, or omit the field to leave it unchanged.

Query Parameters
  • site
    string

    Domain name of the site whose home page content to update. Omit to use the default site.

    Exampledocs.example.com
Body
application/json

Structured content of the home page draft. Null or absent fields in a PATCH request mean "leave unchanged". In a GET response, all populated fields reflect the current draft state.

title
string | null

HTML content for the hero banner title.

Example<h1>Welcome to Our Docs</h1>
subtitle
string | null

HTML content for the hero banner subtitle.

Example<p>Find everything you need here.</p>
backgroundImageFileName
string | null

Storage path to the hero banner background image (e.g. Storage/Branding/bg.jpg). Pass an empty string to remove the image. The file must already exist in Storage.

ExampleStorage/Branding/bg.jpg
popularSearches
object | nullable

Popular (suggested) searches block in the hero banner.

cardList
object | nullable

Cards block settings and card items.

footer
object | nullable

Footer block settings and column contents.

Responses
PATCH/system-pages/home/content


{
  "title": "<h1>Welcome to Our Docs</h1>",
  "subtitle": "<p>Find everything you need here.</p>",
  "backgroundImageFileName": "Storage/Branding/bg.jpg",
  "popularSearches": {
    "label": "Popular:",
    "searches": [
      "getting started",
      "installation"
    ],
    "isShow": true
  },
  "cardList": {
    "title": "<h2>Documentation</h2>",
    "layoutType": "vertical",
    "align": "center",
    "showDescriptions": true,
    "cards": [
      {
        "id": "card-a1b2c3d4",
        "title": "Getting Started",
        "description": "Learn the basics in minutes.",
        "icon": {
          "type": "IconicFont",
          "iconicFontCssClass": "fas fa-book",
          "iconicFontColor": "#3399ff",
          "isDefaultColor": false,
          "imageFullFileName": null
        },
        "link": {
          "type": "externalLink",
          "href": "https://docs.example.com/getting-started",
          "isOpenInNewTab": true
        }
      }
    ]
  },
  "footer": {
    "layoutType": "two",
    "columns": [
      {
        "id": "col-a1b2c3d4",
        "content": "<p>© 2024 Acme Corp</p>"
      }
    ]
  }
}

OK