#Деактивировать сотрудника

DELETE /v1/users/:id

Деактивирует сотрудника — снимает доступ к порталу, но сохраняет всю запись и её связи. Эндпоинт маппится на обновление поля активности (active: false); все данные и история действий остаются в Битрикс24. Восстановить доступ — PATCH /v1/users/:id { active: true }. Требует прав администратора портала.

#Параметры

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

#Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
if (success && data.deactivated) {
  console.log(`Сотрудник ${data.id} деактивирован`)
}

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

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успешной деактивации
data.id number ID деактивированного сотрудника
data.active boolean Всегда false после деактивации
data.deactivated boolean Всегда true — явный маркер семантики операции
data.user object Полная запись сотрудника после деактивации (best-effort: если повторное чтение записи не сработало, поле может отсутствовать — деактивация всё равно выполнена)

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

JSON 
{
  "success": true,
  "data": {
    "id": 1331,
    "active": false,
    "deactivated": true,
    "user": {
      "id": 1331,
      "name": "Иван",
      "lastName": "Петров",
      "email": "ivan.petrov@example.com",
      "active": false,
      "workPosition": "Менеджер",
      "departmentId": [1],
      "USER_TYPE": "employee"
    }
  }
}

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

403 — у владельца ключа нет прав администратора портала:

JSON 
{
  "success": false,
  "error": {
    "code": "UPDATE_FAILED",
    "message": "Bitrix24 rejected user.update for deactivation (result: false)",
    "hint": "Bitrix24 returns false when the calling user lacks portal admin rights, or when the target user id does not exist. Verify the webhook/OAuth identity is a portal admin."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_ID :id не является положительным целым числом
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа user
403 UPDATE_FAILED Битрикс24 вернул result: false. Чаще всего — нет прав администратора портала; реже — сотрудника с таким ID не существует

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

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

Связи остаются. После деактивации сотрудник продолжает значиться ответственным за сделки, автором комментариев, участником чатов. Email остаётся занятым — повторно использовать его при создании нового сотрудника не получится без предварительной реактивации существующего: `PATCH /v1/users/:id { active: true }`.

Best-effort повторное чтение записи. Вайбкод пытается получить актуальную запись после успешной деактивации и кладёт её в data.user. Если вспомогательный вызов упал — поле отсутствует, но сама деактивация уже произведена и подтверждена. Повторный `GET /v1/users/:id` подгрузит запись с active: false.

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