#Удалить рабочую группу

DELETE /v1/workgroups/:id

Удаляет рабочую группу и все связанные с ней данные. Операция необратимая.

#Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) number ★ да — Идентификатор рабочей группы. Список: `GET /v1/workgroups`

#Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/85', {
  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/workgroups/85', {
  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

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

422 — попытка удалить несуществующую группу:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Socialnetwork group not found"
  }
}

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 отказал в удалении. Типичные причины: группа не существует, нет прав на удаление
401 MISSING_API_KEY Не передан X-Api-Key
401 INVALID_API_KEY Передан некорректный ключ
403 SCOPE_DENIED Ключу не хватает скоупа sonet_group

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

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

  • Для временного скрытия группы без потери данных используйте `PATCH /v1/workgroups/:id` с archived: true — группа перестанет показываться в активных списках, но останется доступной для восстановления.
  • Сообщение Socialnetwork group not found возвращается и при отсутствии группы, и при отсутствии прав на удаление — точную причину по ответу определить нельзя.

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