Move a Document note.document.move

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: note

Who can execute the method: a user with access to the Knowledge base module and "Edit" permissions for both the source and the target knowledge base

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The note.document.move method moves a document together with its child pages to another knowledge base, under another parent document, or to another position among its sibling documents.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Document identifier. The identifier can be obtained using the note.document.list or note.document.tree.list method. A document in the archive or the Recycle Bin cannot be moved. Restore it first using the note.document.unarchive or note.document.restore method
collectionId `integer`	Identifier of the target knowledge base. The knowledge base must be active: a document cannot be moved to an archived knowledge base. The identifier can be obtained using the note.collection.list method. Default: the document's current knowledge base
parentId `integer`	Identifier of the parent document in the target knowledge base. The identifier can be obtained using the note.document.tree.list method. If the parameter is not passed, the document becomes a top-level document. To change the order among child pages, pass the `parentId` of the current parent
position `integer`	Sort weight among sibling documents. Documents with a higher weight are placed higher. To place a document between two siblings, pass a number between their `position` values. The retained weight is recalculated based on the sibling documents and may differ from the passed value. The actual value is returned in the response. Default: the document is placed last among its siblings

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.move

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":127,"collectionId":47,"parentId":125,"position":1500}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.move

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":127,"collectionId":47,"parentId":125,"position":1500,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/note.document.move

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentMoveResult = {
          item: {
            id: number
            collectionId: number | null
            parentId: number | null
            title: string
            markdown: string
            position: number
            createdBy: number
            updatedBy: number
            createdAt: ISODate
            updatedAt: ISODate
            contentUpdatedAt: ISODate | null
            state: 'live' | 'archived' | 'trashed'
            isArchived: boolean
            isTrashed: boolean
            isOrphan: boolean
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<DocumentMoveResult>({
            method: 'note.document.move',
            params: {
              id: 127,
              collectionId: 47,
              parentId: 125,
              position: 1500,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Document moved:', result.item.parentId, result.item.position)
          }
        } catch (error) {
          console.error(error)
        }

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function moveDocument() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'note.document.move',
                params: {
                  id: 127,
                  collectionId: 47,
                  parentId: 125,
                  position: 1500,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Document moved:', result.item.parentId, result.item.position)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', moveDocument)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.note.document.move(
                bitrix_id=127,
                collection_id=47,
                parent_id=125,
                position=1500,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

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.move',
                    [
                        'id' => 127,
                        'collectionId' => 47,
                        'parentId' => 125,
                        'position' => 1500,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $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.move',
            {
                id: 127,
                collectionId: 47,
                parentId: 125,
                position: 1500,
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

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.move',
            [
                'id' => 127,
                'collectionId' => 47,
                'parentId' => 125,
                'position' => 1500,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "note.document.move", b24.Params{
        	"id":           127,
        	"collectionId": 47,
        	"parentId":     125,
        	"position":     1500,
        })
        if err != nil {
        	return fmt.Errorf("note.document.move: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ID           b24.ID `json:"id"`
        	CollectionID b24.ID `json:"collectionId"`
        	ParentID     b24.ID `json:"parentId"`
        	Position     int    `json:"position"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.ParentID, item.Position)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 127,
                    "collectionId": 47,
                    "parentId": 125,
                    "title": "VPN Guide",
                    "markdown": "# VPN Guide\n\nConnection setup.",
                    "position": 2000,
                    "createdBy": 1,
                    "updatedBy": 1,
                    "createdAt": "2026-10-21T15:30:05+03:00",
                    "updatedAt": "2026-10-21T15:31:29+03:00",
                    "contentUpdatedAt": "2026-10-21T15:30:05+03:00",
                    "state": "live",
                    "isArchived": false,
                    "isTrashed": false,
                    "isOrphan": false
                }
            },
            "time": {
                "start": 1792585889,
                "finish": 1792585889.7807,
                "duration": 0.7806999683380127,
                "processing": 0,
                "date_start": "2026-10-21T15:31:29+03:00",
                "date_finish": "2026-10-21T15:31:29+03:00",
                "operating_reset_at": 1792586460,
                "operating": 0
            }
        }

In this example, position = 1500 was passed, but the weight 2000 was retained: the value was recalculated based on the sibling documents.

Returned Data

Name `type`	Description
result `object`	Object with the document data
result.item `object`	The document as it was retained after the move
result.item.id `integer`	Document identifier
result.item.collectionId `integer` or `null`	Knowledge base identifier. `null` if the user has access only to the document itself, not to the knowledge base
result.item.parentId `integer` or `null`	Parent document identifier. `null` for a top-level document
result.item.title `string`	Document title
result.item.markdown `string`	Document content in Markdown
result.item.position `integer`	Retained sort weight among sibling documents
result.item.createdBy `integer`	Document author identifier
result.item.updatedBy `integer`	Identifier of the user who last modified the document record
result.item.createdAt `datetime`	Creation date and time in ISO 8601 format with a timezone offset
result.item.updatedAt `datetime`	Date and time the document record was modified. Moving a document updates this field
result.item.contentUpdatedAt `datetime` or `null`	Date and time the Markdown representation of the text was generated
result.item.state `string`	Document state: `live` — active, `archived` — in the archive, `trashed` — in the Recycle Bin
result.item.isArchived `boolean`	Deprecated field. Use `state`. `true` — the document is in the archive
result.item.isTrashed `boolean`	Deprecated field. Use `state`. `true` — the document is in the Recycle Bin
result.item.isOrphan `boolean`	Deprecated field. `true` — the document is in the Recycle Bin and its knowledge base has been deleted
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "NOTE_INVALID_PARENT",
                "message": "Parent article is not part of the specified space."
            }
        }

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`	Required field "id" is missing	Add `id` to the request body
`id`	This request requires data type "int" in field "id"	Pass the identifier as a number

Parent Document Error

Error Code: NOTE_INVALID_PARENT

Field	Error description	How to Fix
`parentId`	Parent article is not part of the specified space	Pass the `parentId` of a document from the target knowledge base, or specify the parent's knowledge base in `collectionId`

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 "Edit" permissions for the source or target knowledge base
`collectionId`	Access denied	The target knowledge base is in the archive. Restore it using the note.collection.unarchive method

Access Escalation Error

Error Code: NOTE_MOVE_ACCESS_ESCALATION

HTTP status: 403

Field	Error description	How to Fix
`-`	Moving the article will make it available to users who are currently denied access. Moderator permissions for the target space are required	The target branch is open to a wider group of users. The move must be performed by a user with "Administration" permissions for the knowledge base

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`id`	Entity with ID #ID# was not found	The document does not exist, is not available to the user, or is in the archive or the Recycle Bin. The root document of a knowledge base, which stores its description, cannot be moved
`collectionId`	Entity with ID #ID# was not found	The target knowledge base does not exist, is not available to the user, or is in the Recycle Bin
`parentId`	Entity with ID #ID# was not found	The parent document does not exist or is not available to the user

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it 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

Was the article helpful?

Unarchive Document

Get Documents List

Move a Document note.document.move

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Parent Document ErrorParent Document Error

Access ErrorsAccess Errors

Access Escalation ErrorAccess Escalation Error

Object Not Found ErrorObject Not Found Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Parent Document Error

Access Errors

Access Escalation Error

Object Not Found Error

Statuses and System Error Codes

Continue Learning