#Удалить сайт

DELETE /v1/sites/:id

Удаляет сайт по идентификатору. Удалить можно только пустой сайт — без страниц (включая страницы в корзине). Если на сайте есть хотя бы одна страница, запрос вернёт ошибку.

#Параметры

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

#Примеры

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

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

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/sites/173" \
  -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/173', {
  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/sites/173', {
  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

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

400 — на сайте есть страницы:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Сайт содержит страницы."
  }
}

#Ошибки

HTTP error.code Маркер в error.message Описание
400 BITRIX_ERROR SITE_IS_NOT_EMPTY На сайте есть страницы (включая страницы в корзине)
400 BITRIX_ERROR SITE_IS_LOCK Сайт заблокирован на удаление
403 BITRIX_ACCESS_DENIED — У пользователя нет права на удаление этого сайта
403 BITRIX_ACCESS_DENIED ACCESS_DENIED_DELETED На портале подключён доменный провайдер — удаление сайта через API недоступно, удалите через интерфейс портала
404 ENTITY_NOT_FOUND — Сайт с таким ID не найден
403 SCOPE_DENIED — API-ключ не имеет скоупа landing
401 TOKEN_MISSING — API-ключ не имеет настроенных токенов

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

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

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

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