Для AI-агентов: markdown этой страницы — /docs-content/entities/pages/update.md индекс документации — /llms.txt

Обновить страницу

PATCH /v1/pages/:id

Обновляет поля существующей страницы. Передавайте только изменяемые поля плоско в корне JSON — без обёртки fields. Не переданные поля сохраняют текущие значения.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор страницы

Поля для обновления (body)

Поле Тип Описание
title string Название страницы, до 255 символов
code string Символьный код страницы. Не должен содержать /. Если код уже занят на сайте — добавляется числовой суффикс
description string Произвольное описание
siteId number ID сайта-владельца. Список: GET /v1/sites
public string Публичность — Y / N
sitemap string Включать в карту сайта — Y / N
xmlId string Внешний код
folderId number ID папки-раздела сайта
tplId number ID шаблона

Поле active в теле не принимается. Запрос с ним отклоняется целиком — ответ 400 READONLY_FIELD, и остальные поля тела не применяются. Публикация и снятие с публикации выполняются отдельными вызовами: POST /v1/pages/:id/publication и POST /v1/pages/:id/unpublish.

Примеры

curl — личный ключ

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/pages/2295" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Весенняя акция — обновлено",
    "description": "Скидки до 50%"
  }'

curl — OAuth-приложение

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/pages/2295" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Весенняя акция — обновлено",
    "description": "Скидки до 50%"
  }'

JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/pages/2295', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Весенняя акция — обновлено',
    description: 'Скидки до 50%',
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/pages/2295', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Весенняя акция — обновлено',
    description: 'Скидки до 50%',
  }),
})

const { success, data } = await res.json()

Поля ответа

Возвращается полный объект обновлённой страницы.

Поле Тип Описание
id number Идентификатор страницы
title string Название страницы
code string Символьный код страницы
siteId number Идентификатор сайта
active boolean Активна ли страница
description string | null Описание страницы
createdById number Идентификатор создавшего сотрудника
dateCreate datetime Дата создания. Строка в формате локали портала, не ISO 8601
dateModify datetime Дата последнего изменения (после обновления)

Формат дат. dateCreate и dateModify — строки в формате локали портала, не ISO 8601 (30.12.2021 12:30:52 на RU-локали, 12/30/2021 12:30:52 pm на EN-локали). Формат одинаков в списке и в карточке; new Date() на таком значении полагаться нельзя. Подробнее: Справочник полей.

Пример ответа

JSON
{
  "success": true,
  "data": {
    "id": 2295,
    "title": "Весенняя акция — обновлено",
    "code": "spring-sale",
    "siteId": 3,
    "active": false,
    "description": "Скидки до 50%",
    "createdById": 1,
    "dateCreate": "08.05.2026 11:49:33",
    "dateModify": "08.05.2026 12:14:08"
  }
}

Пример ответа при ошибке

422 — слеш в code:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Слеш запрещен в адресе лендинга."
  }
}

Ошибки

HTTP error.code Маркер в error.message Описание
400 READONLY_FIELD В теле передано поле только для чтения — например active. Тело не применяется целиком
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 BITRIX_ACCESS_DENIED У пользователя нет права на изменение этой страницы
403 SCOPE_DENIED API-ключ не имеет скоупа landing
404 ENTITY_NOT_FOUND Страница с таким id не найдена или удалена
422 BITRIX_ERROR Слеш запрещен в адресе лендинга В code передан символ /
422 BITRIX_ERROR Адрес страницы не может быть пустым В code передана пустая строка
422 BITRIX_ERROR Недопустимый адрес страницы В code передано значение в формате __

Полный список общих ошибок API — Ошибки.

Смотрите также