#Обновить сотрудника

PATCH /v1/users/:id

Обновляет поля существующего сотрудника. Передавайте только изменяемые поля. Требует прав администратора портала на стороне Битрикс24 — без них вызов отклоняется.

#Часто обновляемые поля

Параметр Тип Описание
workPosition string Должность
departmentId number[] Массив ID отделов. Список: GET /v1/departments
email string Email — должен оставаться уникальным на портале
workPhone / personalPhone / personalMobile string Телефоны
active boolean Реактивировать (true) или деактивировать (false) — деактивация эквивалентна `DELETE /v1/users/:id`

Полный список полей — Поля сотрудника. Пользовательские (UF_*) поля принимаются.

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/users/29" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workPosition": "Старший менеджер",
    "departmentId": [1, 47]
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/users/29" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workPosition": "Старший менеджер",
    "departmentId": [1, 47]
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workPosition: 'Старший менеджер',
    departmentId: [1, 47],
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/29', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workPosition: 'Старший менеджер',
    departmentId: [1, 47],
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Обновлённый объект сотрудника со всеми полями — формат тот же, что у `GET /v1/users/:id`

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

JSON 
{
  "success": true,
  "data": {
    "id": 29,
    "name": "Violetta",
    "lastName": "Веточкина",
    "email": "violetwandere@yandex.ru",
    "active": true,
    "workPosition": "Старший менеджер",
    "departmentId": [1, 47],
    "USER_TYPE": "employee"
  }
}

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

403 — обновление отклонено Битрикс24:

JSON 
{
  "success": false,
  "error": {
    "code": "UPDATE_FAILED",
    "message": "Bitrix24 rejected user.update (result: false)",
    "hint": "Bitrix24 returns false when the calling user lacks portal admin rights, when a read-only field was touched (isOnline, lastLogin, dateRegister, isAdmin), or when the target user ID does not exist. Verify the webhook/OAuth identity is a portal admin."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_ID :id не является положительным целым числом
400 READONLY_FIELD В теле запроса передано readonly-поле (id, isOnline, isAdmin, lastLogin, dateRegister, lastActivityDate). Вайбкод отклоняет до вызова Битрикс24
400 BITRIX_ERROR Битрикс24 отклонил поле — например, wrong_email при попытке поставить уже занятый email
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа user
403 UPDATE_FAILED Битрикс24 вернул result: false для запроса на обновление. Чаще всего — у владельца ключа нет прав администратора портала

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

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

Изменение email. Если новый email уже занят другим сотрудником портала, Битрикс24 вернёт BITRIX_ERROR: wrong_email. Перед PATCH — проверка через GET /v1/users?filter[EMAIL]=новый@example.com.

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