Для AI-агентов: markdown этой страницы — /docs-content/entities/sites/template-areas-delete.md индекс документации — /llms.txt
Очистить области шаблона сайта
DELETE /v1/sites/:id/template-areas
Снимает привязки со всех областей раскладки сайта одним вызовом. Страницы, которые стояли в областях, остаются на сайте, области страниц не меняются.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id (path) |
number | да | ID сайта. Список: GET /v1/sites |
scope (query) |
string | нет | Внутренняя область лендингов: KNOWLEDGE / GROUP / MAINPAGE. Указывайте, если сайт принадлежит соответствующей области. Иначе возвращается 404 ENTITY_NOT_FOUND. Для обычного сайта не передаётся |
Тело запроса не нужно: тело с любым полем отвечает 400 INVALID_PARAMS.
Примеры
curl — личный ключ
curl -X DELETE "https://vibecode.bitrix24.tech/v1/sites/225/template-areas" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X DELETE "https://vibecode.bitrix24.tech/v1/sites/225/template-areas" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/225/template-areas', {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data } = await res.json()
console.log('Области очищены:', success && Object.keys(data.areas).length === 0)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/225/template-areas', {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data } = await res.json()
Поля ответа
Метод отвечает 200 с телом, а не 204: в ответе — привязки сайта после очистки.
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data.areas |
object | Привязки областей сайта после очистки. При успехе всегда пустой объект {}. Формат непустого объекта — Получить области шаблона сайта |
Пример ответа
{
"success": true,
"data": {
"areas": {}
}
}
Пример ответа при ошибке
409 — в это же время идёт другая запись областей этого сайта:
{
"success": false,
"error": {
"code": "TEMPLATE_AREAS_BUSY",
"message": "Another template-area update is in progress; retry"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 409 | TEMPLATE_AREAS_BUSY |
Другой запрос через API в это же время меняет области этого сайта. Повторите запрос, когда та запись завершится |
| 404 | ENTITY_NOT_FOUND |
Сайт с таким ID не найден, недоступен пользователю или лежит в другой области: передан не тот scope |
| 400 | INVALID_PARAMS |
id must be a positive safe integer — id не является положительным целым числом |
| 400 | INVALID_PARAMS |
Unsupported body field — в теле есть поле, которого метод не принимает |
| 400 | INVALID_PARAMS |
Body must be a JSON object — тело не является JSON-объектом, например передан массив |
| 400 | INVALID_PARAMS |
Unsupported query parameter — передан query-параметр, которого метод не принимает |
| 400 | INVALID_SCOPE |
scope не равен KNOWLEDGE, GROUP или MAINPAGE |
| 409 | LANDING_MODULE_NOT_ENABLED |
Модуль «Сайты» недоступен на портале. Попросите администратора портала включить его — пока модуль выключен, повтор запроса вернёт тот же отказ |
| 422 | BITRIX_ERROR |
Bitrix24 did not save the template areas; settings permission may be missing — после очистки у сайта остались привязки. Проверьте, есть ли у пользователя право менять настройки сайта |
| 422 | BITRIX_ERROR |
Bitrix24 did not confirm the template-area change — Битрикс24 не подтвердил запись |
| 422 | BITRIX_ERROR |
Bitrix24 returned invalid template areas — Битрикс24 вернул области в неожиданном виде |
| 403 | WRITE_BLOCKED_READONLY_KEY |
Ключ работает в режиме только для чтения. Запрос отклоняется до обращения к порталу |
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа landing |
| 401 | TOKEN_MISSING |
API-ключ не имеет настроенных токенов |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Повторная очистка безопасна. Вызов на сайте без привязок отвечает
200с пустымdata.areas.