Для AI-агентов: markdown этой страницы — /docs-content/chats/messages/blocks-update.md индекс документации — /llms.txt

Заменить блок в сообщении

PATCH /v1/chats/messages/:messageId/blocks/:blockId

Заменяет блок сообщения-конструктора целиком.

Параметры

Параметр Тип Обяз. По умолч. Описание
messageId (path) number да — ID сообщения-конструктора, положительное целое — data.id ответа отправки в режиме v2 или id сообщения с непустым block в Сообщениях вокруг сообщения
blockId (path) string да — ID блока — значение block.elements[].id сообщения. Блоки сообщения — Сообщения вокруг сообщения

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

Поле Тип Обяз. Описание
element object да Новый блок в формате конструктора Битрикс24: type и поля этого типа, например { "type": "text", "text": "Сборка упала" }

Другие поля тела и параметры запроса отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/chats/messages/1001/blocks/650a1b2c3d4e5" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "element": { "type": "text", "text": "Сборка упала" } }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/chats/messages/1001/blocks/650a1b2c3d4e5" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "element": { "type": "text", "text": "Сборка упала" } }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1001/blocks/650a1b2c3d4e5', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ element: { type: 'text', text: 'Сборка упала' } }),
})

const { data } = await res.json()
console.log('Блок заменён:', data.result)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1001/blocks/650a1b2c3d4e5', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ element: { type: 'text', text: 'Сборка упала' } }),
})

const { data } = await res.json()
console.log('Блок заменён:', data.result)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — блок заменён

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

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

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

422 — блока с таким ID нет:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "ELEMENT_NOT_FOUND",
    "b24Code": "ELEMENT_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не положительное целое, тело не JSON-объект, element не передан или не объект, лишнее поле тела или параметр запроса. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул общий код «не найдено» или ошибку с текстом «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. MESSAGE_NOT_FOUND — сообщения с таким ID нет, BLOCK_NOT_FOUND — у сообщения нет блоков, ELEMENT_NOT_FOUND — блока с таким ID нет, WRONG_ELEMENT_TYPE и EMPTY_TEXT_FIELD — блок собран неверно, BLOCK_LENGTH_EXCEEDED — блоки сообщения превысили лимит длины, MESSAGE_ACCESS_DENIED — нет права править сообщение, например оно чужое
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

element.id не меняет ID блока. Блок сохраняет ID из пути, даже если в element.id передан другой.

Блоки есть только у сообщения-конструктора. Сообщение становится конструктором, когда его отправляют с полем block в режиме v2 отправки или задают ему блоки правкой сообщения в режиме v2. У обычного сообщения блоков нет.

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