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

Снять системную страницу

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

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID сайта. Список: GET /v1/sites
type (path) string да Роль, которую нужно освободить: mainpage, catalog, personal, cart, order, payment, compare, feedback. Занятые роли — GET /v1/sites/:id/system-pages
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/cart" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/sites/223/system-pages/cart" \
  -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/cart', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Осталось ролей:', data.length)

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

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

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

Поля ответа

Метод отвечает 200 и возвращает оставшиеся привязки сайта.

Поле Тип Описание
success boolean Всегда true при успехе
data array Привязки сайта после снятия роли. Если роль была последней — пустой массив
data[].type string Роль: mainpage, catalog, personal, cart, order, payment, compare, feedback. Что значит каждая — Системные страницы
data[].pageId number ID страницы, назначенной на роль. Получить страницу: GET /v1/pages/:id
data[].title string Название страницы
data[].deleted boolean Страница лежит в корзине
data[].active boolean Страница опубликована

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

JSON 
{
  "success": true,
  "data": [
    {
      "type": "personal",
      "pageId": 2373,
      "title": "Docs test personal",
      "deleted": false,
      "active": false
    }
  ]
}

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

404 — роль уже свободна:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "System-page binding not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND System-page binding not found — на роль type не назначена страница. Повторное снятие той же роли отвечает так же
404 ENTITY_NOT_FOUND Entity not found or not visible — сайт с таким ID не найден, недоступен пользователю или лежит в другой области
400 INVALID_PARAMS Unknown system-page type — type не входит в список ролей
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 — Ошибки.

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