Update home page settings

Update home page settings

Partially updates home page draft settings from a flat key-value JSON body. Key absent means the setting is left unchanged. Key present (even with null) means the setting is updated. The live page is not affected until /system-pages/home/publish is called.

Query Parameters
  • site
    string

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

    Exampledocs.example.com
Body
application/json

Flat key-value map of home page appearance and SEO settings. All values are strings or null.

fontName
string | null

Font family name used on the home page.

ExampleArial
fontColor
string | null

Text color (hex).

Example#333333
backgroundColor
string | null

Page background color (hex).

Example#ffffff
linkColor
string | null

Link color (hex).

Example#0066cc
title
string | null

Home page title.

ExampleMy Portal
metaDescription
string | null

SEO meta description.

ExampleFind all documentation here.
metaKeywords
string | null

SEO meta keywords.

Exampledocs, help
additionalTags
string | null

Additional raw HTML tags injected into the page <head>.

additional properties
string | null
Responses
PATCH/system-pages/home/settings


{
  "fontName": "Arial",
  "fontColor": "#333333",
  "backgroundColor": "#ffffff",
  "linkColor": "#0066cc",
  "title": "My Portal",
  "metaDescription": "Find all documentation here.",
  "metaKeywords": "docs, help",
  "additionalTags": null
}

OK