#Обновить чат

PATCH /v1/bots/:botId/chats/:dialogId

Обновляет настройки чата. Бот должен быть участником чата. Обновляются только переданные поля.

Две формы тела запроса — обе корректны. Платформа принимает плоскую запись ({ title, description, ... }) и формат Битрикс24 с обёрткой fields. Если в теле есть fields, запрос передаётся в Битрикс24 без изменений. Иначе известные поля верхнего уровня автоматически разворачиваются в fields.*.

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

Параметр (плоский) Параметр (формат Битрикс24) Тип Описание
title fields.title string Новое название чата
description fields.description string Новое описание
color fields.color string Новый цвет
avatar fields.avatar string Новый URL аватара

#Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "title": "Новое название чата",
      "description": "Обновлённое описание"
    }
  }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "title": "Новое название чата",
      "description": "Обновлённое описание"
    }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      title: 'Новое название чата',
      description: 'Обновлённое описание',
    },
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      title: 'Новое название чата',
      description: 'Обновлённое описание',
    },
  }),
})

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

#Поля ответа

Поле Тип Описание
data.result boolean true при успешном обновлении

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

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

403 — бот принадлежит другому ключу:

JSON 
{
  "success": false,
  "error": {
    "code": "BOT_ACCESS_DENIED",
    "message": "This bot belongs to a different API key"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Битрикс24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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