Обновление контента домашней страницы

Обновление контента домашней страницы

Обновляет черновик контента домашней страницы. Обновляются только указанные поля. Поля со значением null или отсутствующие поля остаются без изменений.

Работа с карточками: получите текущий список карточек через GET /system-pages/home/content, отредактируйте массив и отправьте его целиком. Карточки с существующим id сохраняются; карточки без id получают новый идентификатор автоматически.

Опубликованная версия страницы не изменяется до вызова POST /system-pages/home/publish.

backgroundImageFileName: укажите путь к существующему файлу в хранилище (например, Storage/Branding/bg.jpg), пустую строку для удаления фона, или не передавайте поле, чтобы оставить текущее значение без изменений.

Query Parameters
  • site
    string

    Доменное имя сайта, контент которого нужно обновить. Если не указано, используется сайт по умолчанию.

    Exampledocs.example.com
Body
application/json

Структурированный контент черновика домашней страницы. Null или отсутствующие поля в PATCH-запросе означают «не изменять». В ответе GET все заполненные поля отражают текущее состояние черновика.

title
string | null

HTML-контент заголовка баннера-заголовка.

Example<h1>Добро пожаловать в нашу документацию</h1>
subtitle
string | null

HTML-контент подзаголовка баннера-заголовка.

Example<p>Найдите всё, что нужно, здесь.</p>
backgroundImageFileName
string | null

Путь к фоновому изображению баннера-заголовка в хранилище (например, Storage/Branding/bg.jpg). Передайте пустую строку, чтобы удалить изображение. Файл должен уже существовать в хранилище.

ExampleStorage/Branding/bg.jpg
popularSearches
object | nullable

Блок предлагаемых поисковых запросов в баннере-заголовке.

cardList
object | nullable

Настройки списка карточек и сами карточки.

footer
object | nullable

Настройки футера и содержимое столбцов.

Responses
PATCH/system-pages/home/content


{
  "title": "<h1>Добро пожаловать в нашу документацию</h1>",
  "subtitle": "<p>Найдите всё, что нужно, здесь.</p>",
  "backgroundImageFileName": "Storage/Branding/bg.jpg",
  "popularSearches": {
    "label": "Популярные запросы:",
    "searches": [
      "начало работы",
      "установка"
    ],
    "isShow": true
  },
  "cardList": {
    "title": "<h2>Документация</h2>",
    "layoutType": "vertical",
    "align": "center",
    "showDescriptions": true,
    "cards": [
      {
        "id": "card-a1b2c3d4",
        "title": "Начало работы",
        "description": "Изучите основы за несколько минут.",
        "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