Edit a message

PATCH /v1/chats/:dialogId/messages/:messageId

Updates the text of a previously sent message. The API cannot restore the original text after an edit — send a new message if needed.

Parameters

The v2 mode. format=v2 edits the message: besides the text it changes the attach, keyboard, menu and block blocks — with or without the text — and urlPreview turns the link preview on and off. data carries { "result": true } instead of true. Without message the text stays as it was. An edit that could turn into a deletion is refused before Bitrix24 is called, as in the regular mode: text that is empty by the Bitrix24 rule gets 400 MESSAGE_REQUIRED. Removing a block ([], {} or "") without new text in the same request gets 400 INVALID_PARAMS, because a message left with no text and no blocks would be deleted, and the platform cannot see whether the message has text. At least one of message, attach, keyboard, menu, block is required. In the v2 mode message must be a string. Any other body field and any query parameter other than format are rejected with 400 INVALID_PARAMS, and botId is rejected with a pointer to editing as a bot. The message must belong to the dialog in the path: after the input checks, the platform reads that dialog without joining the chat and, if the message is not there, returns 404 ENTITY_NOT_FOUND and changes nothing. The me alias is resolved before this check. The regular mode does not check dialogId.

Request body fields

Message layout

• Text formatting — BB codes in the message text

For a non-empty update, the message text is limited to 20000 Unicode code points. The complete outgoing string is counted, including markup, URLs and mentions, without truncation or trimming. For example, 😀 is one code point, while a compound emoji may occupy several. Text that is empty by Bitrix24's rule is rejected with MESSAGE_REQUIRED before this length check, even when it contains more than 20000 code points. The request is rejected before any call to Bitrix24.

Without format=v2, matching text aliases message, MESSAGE, Message and fields.message are accepted, including other case variants. Their values must agree. A conflict returns 400 INVALID_PARAMS. An object is never converted to text. The v2 mode keeps its flat body whitelist: case variants and fields are not accepted.

Examples

curl — personal key

curl -X PATCH https://vibecode.bitrix24.com/v1/chats/42/messages/36889 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Invoice confirmed. Thank you."
  }'

curl — OAuth application

curl -X PATCH https://vibecode.bitrix24.com/v1/chats/42/messages/36889 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Invoice confirmed. Thank you."
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/42/messages/36889', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Invoice confirmed. Thank you.',
  }),
})

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/42/messages/36889', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Invoice confirmed. Thank you.',
  }),
})

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

curl — the v2 mode

curl -X PATCH "https://vibecode.bitrix24.com/v1/chats/42/messages/36889?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyboard": [{ "TEXT": "Open the invoice", "LINK": "https://example.com/invoice" }]
  }'

Response fields

Response example

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

Error response example

422 — the message was not found, the edit time has expired, or there is no access:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Time has expired for modification or you don't have access",
    "b24Code": "CANT_EDIT_MESSAGE"
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

Empty text is not an update. Text that is empty by the Bitrix24 rule would delete the message, so such a request is refused before Bitrix24 is called — see MESSAGE_REQUIRED in the errors table. To delete a message, use DELETE /v1/chats/:dialogId/messages/:messageId. A number in message is accepted and stored as text.

Only message is sent to Bitrix24. In the regular mode other fields of the request body are not forwarded to Bitrix24 — including Bitrix24's own upper-case keys. In the v2 mode the fields from the table are forwarded, and the rest are rejected. Bitrix24 compares parameter names case-insensitively and the last key takes effect: an alias such as Message: "" beside MESSAGE would delete the message.

System messages cannot be edited. Messages sent with system: true have authorId = 0. They cannot be changed — the API returns an error.

An edit without changes. In the v2 mode even an edit that changes nothing may mark the message as edited if other members have already seen it.

See also

• Messages
• Send a message
• Delete a message
• Read messages