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

PATCH /v1/departments/:id

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

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

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

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

#Примеры

#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()

#Поля ответа

Поле Тип Описание
data object Обновлённый объект отдела со всеми полями — см. Поля

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

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

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

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

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

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Отдел не найден
422 BITRIX_ERROR parentId ссылается на несуществующий отдел, или headId ссылается на несуществующего сотрудника
403 SCOPE_DENIED API-ключ не имеет скоупа department
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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