Для AI-агентов: markdown этой страницы — /docs-content/entities/departments/update.md индекс документации — /llms.txt

Обновить отдел

PATCH /v1/departments/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID отдела. Список: GET /v1/departments

Поля запроса (body)

Все поля необязательные, но тело должно содержать хотя бы одно из них.

Поле Тип Описание
name string Название отдела
parentId number ID нового родительского отдела — для перемещения отдела в дереве. Должен ссылаться на существующий отдел. Список: GET /v1/departments
headId number Новый руководитель. Источник: GET /v1/users
sort number Порядок среди отделов того же уровня

Полный список полей — Поля отдела.

headId не проверяется на существование. Несуществующий userId в headId принимается и сохраняется, запрос возвращает 200. Проверяется только parentId: несуществующий родитель — 422 BITRIX_ERROR. Перед назначением убедитесь, что пользователь существует — GET /v1/users.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/departments/47" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Коммерческий отдел Запад",
    "headId": 101
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/departments/47" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Коммерческий отдел Запад",
    "headId": 101
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/departments/47', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Коммерческий отдел Запад',
    headId: 101,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/departments/47', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Коммерческий отдел Запад',
    headId: 101,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Отдел после обновления. Описание полей — Поля отдела
data.id number ID отдела
data.name string Название отдела
data.parentId number ID родительского отдела
data.headId number ID руководителя отдела. Если руководитель не назначен, приходит 0 или поле отсутствует
data.sort number Порядок отдела среди соседей

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

JSON 
{
  "success": true,
  "data": {
    "id": 47,
    "name": "Коммерческий отдел Запад",
    "sort": 500,
    "parentId": 1,
    "headId": 101
  }
}

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

404 — отдел не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Department not found"
  }
}

Ошибки

HTTP Код Описание
400 EMPTY_UPDATE_BODY Тело запроса пустое — передайте хотя бы одно поле
400 READONLY_FIELD В теле передано поле только для чтения, например id
404 ENTITY_NOT_FOUND Отдел с таким id не найден
422 BITRIX_ERROR parentId ссылается на несуществующий отдел. Сообщение: «Неверный раздел-родитель!»
403 SCOPE_DENIED API-ключ не имеет скоупа department
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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