Удалить страницу

DELETE /v1/pages/:id

Удаляет страницу по идентификатору. Восстановить удалённую страницу через API нельзя — создавайте новую при необходимости.

Параметры

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

Примеры

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

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

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

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

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

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

if (res.status === 204) {
  console.log('Страница удалена')
}

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

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

if (res.status === 204) {
  console.log('Страница удалена')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом — успех проверяется по статусу.

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

http 
HTTP/1.1 204 No Content

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

404 — страница не найдена или уже удалена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Лендинг не найден."
  }
}

Ошибки

HTTP error.code Описание
404 ENTITY_NOT_FOUND Страница с таким ID не найдена или уже удалена
403 BITRIX_ACCESS_DENIED У пользователя нет права на удаление этой страницы
403 SCOPE_DENIED API-ключ не имеет скоупа landing
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Удаление освобождает код страницы. После удаления символьный код снова свободен — новую страницу с тем же code на том же сайте можно создать сразу.

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