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

Снять все системные страницы сайта

DELETE /v1/sites/:id/system-pages

Освобождает все системные роли сайта одним вызовом. Страницы, которые были на них назначены, остаются на сайте.

Параметры

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

Тело запроса не нужно: тело с любым полем отвечает 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/sites/223/system-pages" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/sites/223/system-pages" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/223/system-pages', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Роли сняты:', success && data.length === 0)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/223/system-pages', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Привязки сайта после снятия. При успехе всегда пустой массив. Формат элемента — type, pageId, title, deleted, active — описан в Списке системных страниц сайта

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

JSON 
{
  "success": true,
  "data": []
}

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

404 — сайт с таким ID не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Entity not found or not visible"
  }
}

Ошибки

HTTP Код Описание
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 binding change; site settings permission may be missing — после записи у сайта остались привязки. Проверьте, есть ли у пользователя право менять настройки сайта
422 BITRIX_ERROR Bitrix24 did not confirm the binding change — Битрикс24 не подтвердил запись
422 BITRIX_ERROR Bitrix24 returned invalid system pages — Битрикс24 вернул список привязок в неожиданном виде
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения. Запрос отклоняется до обращения к порталу
403 SCOPE_DENIED API-ключ не имеет скоупа landing
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

Известные особенности

  • Повторное снятие безопасно. Вызов на сайте без привязок отвечает 200 с пустым data, в отличие от снятия одной роли, которое на свободную роль отвечает 404.

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