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

Изменить области шаблона сайта

PATCH /v1/sites/:id/template-areas

Привязывает страницы к областям раскладки сайта или снимает привязку с отдельных областей. Переданные области меняются, остальные привязки сайта сохраняются.

Параметры

Параметр	Тип	Обяз.	Описание
`id` (path)	number	да	ID сайта. Список: `GET /v1/sites`
`scope` (query)	string	нет	Внутренняя область лендингов: `KNOWLEDGE` / `GROUP` / `MAINPAGE`. Указывайте, если сайт принадлежит соответствующей области. Иначе возвращается `404 ENTITY_NOT_FOUND`. Для обычного сайта не передаётся

Поля запроса (body)

Поле	Тип	Обяз.	Описание
`areas`	object	да	Изменяемые области, хотя бы одна. Ключ — номер области: целое число со знаком от `-2147483648` до `2147483647`, включая `0`. Значение — ID страницы, которая встанет в область, или `null`, чтобы снять привязку с этой области. Список страниц: `GET /v1/pages`

Других полей тело не принимает: лишнее поле отвечает 400 INVALID_PARAMS. Снять привязки со всех областей сразу — DELETE /v1/sites/:id/template-areas.

Примеры

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/sites/225/template-areas" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"areas": {"1": 2383, "2": 2385}}'

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/sites/225/template-areas" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"areas": {"1": 2383, "2": 2385}}'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/225/template-areas', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ areas: { 1: 2383, 2: 2385 } }),
})

const { success, data } = await res.json()
console.log('Области сайта:', data.areas)

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/225/template-areas', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ areas: { 1: 2383, 2: 2385 } }),
})

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

Поля ответа

В ответе — все привязки сайта после изменения, а не только переданные.

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data.areas`	object	Привязки областей сайта. Ключ — номер области строкой в десятичной записи, значение — ID страницы. Получить страницу: `GET /v1/pages/:id`. Если после изменения привязок не осталось — пустой объект `{}`

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

JSON

{
  "success": true,
  "data": {
    "areas": {
      "1": 2383,
      "2": 2385
    }
  }
}

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

409 — в это же время идёт другая запись областей этого сайта: