## Обновить рабочую группу

`PATCH /v1/workgroups/:id`

Обновляет указанные поля рабочей группы. Возвращает полный объект группы после обновления. Неупомянутые в теле поля остаются без изменений.

## Параметры

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

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

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

| Поле | Тип | Обяз. | По умолч. | Описание |
|------|-----|:-----:|-----------|---------|
| `name` | string | нет | текущее значение | Название рабочей группы |
| `description` | string | нет | текущее значение | Описание |
| `ownerId` | number | нет | текущее значение | Идентификатор нового владельца группы. Список: `GET /v1/users` |
| `subjectId` | number | нет | текущее значение | Идентификатор темы |
| `active` | boolean | нет | текущее значение | Активна ли группа |
| `visible` | boolean | нет | текущее значение | Видна ли в общих списках |
| `opened` | boolean | нет | текущее значение | Открыта ли для вступления без приглашения |
| `archived` | boolean | нет | текущее значение | Помещена ли в архив |
| `isProject` | boolean | нет | текущее значение | Является ли проектом |
| `isExtranet` | boolean | нет | текущее значение | Группа экстранета |
| `keywords` | string | нет | текущее значение | Ключевые слова для поиска |

Поля `id`, `subjectName`, `membersCount`, `dateCreate`, `dateUpdate`, `dateActivity`, `siteId`, `imageUrl` доступны только для чтения. Передача любого из них в теле возвращает `400 READONLY_FIELD`.

## Примеры

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/workgroups/85" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Обновлённое описание команды",
    "opened": true,
    "archived": false
  }'
```

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/workgroups/85" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Обновлённое описание команды",
    "opened": true,
    "archived": false
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/85', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    description: 'Обновлённое описание команды',
    opened: true,
    archived: false,
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/85', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    description: 'Обновлённое описание команды',
    opened: true,
    archived: false,
  }),
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Полный объект рабочей группы после обновления — все поля см. [Получить рабочую группу](./get.md) |

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

```json
{
  "success": true,
  "data": {
    "id": 85,
    "siteId": "s1",
    "name": "Маркетинг 2026",
    "description": "Обновлённое описание команды",
    "dateCreate": "2026-05-12T08:14:21.000Z",
    "dateUpdate": "2026-05-26T05:58:08.000Z",
    "active": true,
    "visible": true,
    "opened": true,
    "archived": false,
    "subjectId": 1,
    "ownerId": 1,
    "keywords": "проект,команда",
    "membersCount": 7,
    "dateActivity": "2026-05-26T05:58:08.000Z",
    "subjectName": "Рабочие группы",
    "isProject": false,
    "isExtranet": false
  }
}
```

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

Битрикс24 не различает «группа не существует» и «нет прав на обновление»:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "User has no permissions to update group"
  }
}
```

## Ошибки

| HTTP | `error.code` | Описание |
|------|--------------|---------|
| 400 | `READONLY_FIELD` | В теле передано поле, доступное только для чтения (`id`, `subjectName`, `membersCount`, `dateCreate`, `dateUpdate`, `dateActivity`, `siteId`, `imageUrl`) |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в обновлении. Текст в `error.message`. Типичные причины: ошибка валидации, конфликт значений, отсутствие прав на изменение, отсутствие рабочей группы с указанным `id` (два последних случая возвращают одинаковое сообщение) |
| 401 | `MISSING_API_KEY` | В запросе не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Переданный ключ недействителен или отозван |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `sonet_group` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- Сообщение `User has no permissions to update group` возвращается и при отсутствии рабочей группы с указанным `id`, и при отсутствии прав на её изменение. Чтобы различить эти два случая, сделайте дополнительный запрос [`GET /v1/workgroups/:id`](./get.md): ответ `404` — группы нет, успешный ответ — нет прав на изменение.

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

- [Создать рабочую группу](./create.md)
- [Получить рабочую группу](./get.md)
- [Список рабочих групп](./list.md)