#Переименовать чат

PATCH /v1/chats/:chatId

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

#Параметры

Параметр Тип Обяз. Описание
chatId (path) number да Числовой ID чата. Получить: POST /v1/chats или GET /v1/chats/recent

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

Поле Тип Обяз. Описание
title string да Новое название чата. Не может быть пустым

#Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/chats/3663 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Проект Бета"
  }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/chats/3663 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Проект Бета"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/3663', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Проект Бета',
  }),
})

const { success, data } = await res.json()
console.log('Переименован:', data) // true

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/3663', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Проект Бета',
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true при успешном переименовании

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

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

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

400 — передан пустой заголовок:

JSON 
{
  "success": false,
  "error": {
    "code": "TITLE_EMPTY",
    "message": "title is required and cannot be blank."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_CHAT_ID chatId не является положительным целым числом
400 TITLE_EMPTY Поле title отсутствует или пустое
404 CHAT_NOT_FOUND_OR_NO_ACCESS Чат не существует или у вызывающего нет прав на переименование
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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