Update Document note.document.update

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: note

Who can execute the method: a user with access to the Knowledge base module and "Edit" permissions for the required document or document knowledge base

The note.document.update method updates the heading and/or the content of a document.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Document identifier. The identifier can be obtained using the note.document.tree.list method.
fields* `object`	An object with the fields that need to be changed. Object structure description
overwrite `boolean`	Determines whether to force overwrite the document content if it has unsaved changes from a collaborative editor. Possible values: `true` — overwrite the document content `false` — do not overwrite the content if there are unsaved changes Default: `false` Use this if you are passing `fields.markdown`

Parameter fields

Name
type

Description

title
string

New document title.

The document title must not exceed 255 characters.

Pass fields.title, fields.markdown, or both fields at once.

markdown
string

New document content in Markdown.

To add a file to the document, insert assetMarkdown, obtained via the note.file.get or note.file.add method, as a separate line at the beginning of the line, without a prefix or suffix in the same line.

Maximum size: 1 048 576 bytes.

Pass fields.title, fields.markdown, or both fields at once.

If the document is currently being edited in the interface, the method will return error NOTE_DOCUMENT_HAS_UNSAVED_CHANGES. To force overwrite the content, repeat the request with overwrite=true. All active editors will be sent a signal via a P&P event to reload the current content.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/note.document.update

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":77,"fields":{"title":"Chapter 1 (updated)","markdown":"# Chapter 1\N\nUpdated Text"},"Overwrite":False}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":77,"fields":{"title":"Chapter 1 (updated)","markdown":"# Chapter 1\N\nUpdated Text"},"Overwrite":False,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/note.document.update

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentUpdateResult = {
          item: {
            id: number
            collectionId: number | null
            parentId: number | null
            title: string
            markdown: string
            position: number
            createdBy: number
            updatedBy: number
            createdAt: string
            updatedAt: string
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<DocumentUpdateResult>({
            method: 'note.document.update',
            params: {
              id: 77,
              fields: {
                title: 'Chapter 1 (updated)',
                markdown: '# Chapter 1\N\nUpdated Text',
              },
              overwrite: false,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Document updated:', result.item.id, result.item.title)
          }
        } catch (error) {
          console.error(error)
        }

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateDocument() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'note.document.update',
                params: {
                  id: 77,
                  fields: {
                    title: 'Chapter 1 (updated)',
                    markdown: '# Chapter 1\N\nUpdated Text',
                  },
                  overwrite: false,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Document updated:', result.item.id, result.item.title)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateDocument)
        </script>

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'note.document.update',
                    [
                        'id' => 77,
                        'fields' => [
                            'title' => 'Chapter 1 (updated)',
                            'markdown' => "# Chapter 1\N\nUpdated Text",
                        ],
                        'overwrite' => false,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating document: ' . $e->getMessage();
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'note.document.update',
            {
                id: 77,
                fields: {
                    title: 'Chapter 1 (updated)',
                    markdown: '# Chapter 1\N\nUpdated Text'
                },
                overwrite: false
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'note.document.update',
            [
                'id' => 77,
                'fields' => [
                    'title' => 'Chapter 1 (updated)',
                    'markdown' => "# Chapter 1\N\nUpdated Text"
                ],
                'overwrite' => false
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 77,
                    "collectionId": 42,
                    "parentId": 10,
                    "title": "Chapter 1 (updated)",
                    "markdown": "# Chapter 1\N\nUpdated Text",
                    "position": 5,
                    "createdBy": 1,
                    "updatedBy": 1,
                    "createdAt": "2026-04-20T12:00:00Z",
                    "updatedAt": "2026-04-21T09:15:30Z"
                }
            },
            "time": {
                "start": 1780391100,
                "finish": 1780391100.266341,
                "duration": 0.266340970993042,
                "processing": 0.22421908378601074,
                "date_start": "2026-06-16T12:05:00+03:00",
                "date_finish": "2026-06-16T12:05:00+03:00",
                "operating_reset_at": 1780391700,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the document update result
item `object`	Document object after the update
id `integer`	Document identifier
collectionId `integer`	Knowledge base identifier or `null` if the document is available via direct document access
parentId `integer`	Parent document identifier or `null`
title `string`	Document title
markdown `string`	Document content in Markdown
position `integer`	Document position among neighboring pages
createdBy `integer`	Identifier of the document author
updatedBy `integer`	Identifier of the last document editor
createdAt `datetime`	Document creation date and time in UTC
updatedAt `datetime`	Document last modified date and time in UTC
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "NOTE_EMPTY_UPDATE",
                "message": "The request does not contain any modifiable fields"
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`id` `fields`	Required field `#FIELD#` is not specified	Add the specified field to the request body
`id` `overwrite`	Field `#FIELD#` requires data type `#TYPE#` for this request	Ensure the provided value is of the correct type

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`title` `markdown`	Field `#FIELD#` requires data type `#TYPE#` for this request	Ensure the provided value is of the correct type
`title`	Document title cannot be empty	Pass a non-empty string in the `fields.title` field
`title`	Document title must not exceed 255 characters	Shorten the value of `fields.title`

Error Code: NOTE_EMPTY_UPDATE

Field	Error description	How to Fix
`fields.title` `fields.markdown`	The request does not contain any changeable fields	Pass `fields.title`, `fields.markdown`, or both fields at once

Error Code: NOTE_MARKDOWN_TOO_LARGE

Field	Error description	How to Fix
`markdown`	Document content is too large. The maximum allowed size is `1 048 576` bytes	Shorten the content of `fields.markdown`

Conflict Error

Error Code: NOTE_DOCUMENT_HAS_UNSAVED_CHANGES

Field	Error description	How to Fix
`overwrite`	The document has unsaved changes. Pass the `overwrite=true` parameter to overwrite the content	Retry the request with `overwrite=true` if you need to force overwrite the document content

Access Errors

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field	Error description	How to Fix
`-`	Access denied	The user does not have access to the Knowledge Base module or permissions to edit the document

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`id`	Document not found	Check that the document exists, is not archived, and is not in the trash

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Create Document

Retrieve Document

Update Document note.document.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Conflict ErrorConflict Error

Access ErrorsAccess Errors

Object Not Found ErrorObject Not Found Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Conflict Error

Access Errors

Object Not Found Error

Statuses and System Error Codes

Continue Learning