## Изменить описание чата

`PUT /v1/chats/:dialogId/description`

Заменяет описание чата текстом из запроса. Пустая строка стирает описание.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `dialogId` (path) | string | да | ID диалога: `chatXXX` для группового чата, числовой ID пользователя для личных сообщений, `me` — личный диалог текущего пользователя. Чат сущности CRM находится через [Найти чат CRM-сущности](/docs/chats/discovery/find) |

Query-параметров у эндпоинта нет: любой параметр в строке запроса отклоняется с `400 INVALID_PARAMS`.

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `description` | string | да | Новое описание. Пробелы по краям портал отрезает. Пустая строка `""` стирает описание |

Другие поля тела отклоняются с `400 INVALID_PARAMS`, сообщение называет лишнее поле.

## Примеры

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

```bash
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/description \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description": "Закупка оборудования для склада"}'
```

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

```bash
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/description \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description": "Закупка оборудования для склада"}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/description', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ description: 'Закупка оборудования для склада' }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/description', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ description: 'Закупка оборудования для склада' }),
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | boolean | `true` — описание сохранено |

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

```json
{
  "success": true,
  "data": true
}
```

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

400 — в теле нет поля `description`:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `description` must be a string — the new description; an empty string clears it."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `description` нет в теле или это не строка, в теле другое поле, тело не JSON-объект, в строке запроса есть параметр. Проверяется до обращения к Битрикс24 |
| 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал: пользователь не участник чата или право `ui` не разрешает ему менять описание |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`. Чата нет — `CHAT_NOT_FOUND` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ в режиме «только чтение» — изменение описания считается записью |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | `dialogId=me` — не удалось определить ID текущего пользователя |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |

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

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

**Текущее описание.** Сохранённый текст приходит в поле `description` ответа [Информация о диалоге](/docs/chats/discovery/get). Смена описания не пишет в чат системного сообщения.

**Кто может менять описание.** Описание, цвет и аватар чата меняет тот, кому это разрешает право `ui`. Кому оно выдано, задаёт [`PUT /v1/chats/:dialogId/permissions/ui`](/docs/chats/management/permissions-ui), текущее значение — поле `permissions.manageUi` ответа [Информация о диалоге](/docs/chats/discovery/get).

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

- [Переименовать чат](/docs/chats/management/rename)
- [Изменить цвет чата](/docs/chats/management/color)
- [Изменить аватар чата](/docs/chats/management/avatar)
- [Установить право менять оформление чата](/docs/chats/management/permissions-ui)
- [Информация о диалоге](/docs/chats/discovery/get)