Change Knowledge Base Position note.collection.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 the "Create Knowledge Bases" permission

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.collection.move method moves a knowledge base to a different position in the list of knowledge bases.

The order of knowledge bases is shared across the entire Bitrix24: all employees see the change in the left menu.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Knowledge base identifier.

The identifier can be obtained using the note.collection.list method.

A knowledge base that is archived or in the Recycle Bin cannot be moved

position
integer

Sort weight of the knowledge base. Knowledge bases with a higher weight appear higher in the list. To place a knowledge base between two others, pass a number between their position values.

The retained weight is recalculated based on the neighboring knowledge bases and may differ from the value passed. The actual value is returned in the response.

Default: the knowledge base is placed last in the list

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.collection.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":47,"position":500}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.move

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

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CollectionMoveResult = {
          item: {
            id: number
            name: string
            position: number
            policyLevel: string
            accessLevel: string
            state: 'live' | 'archived' | 'trashed'
            isArchived: boolean
            createdBy: number
            createdAt: ISODate
            updatedBy: number
            updatedAt: ISODate
            markdownDescription: string | null
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<CollectionMoveResult>({
            method: 'note.collection.move',
            params: {
              id: 47,
              position: 500,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Collection position:', 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 moveCollection() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'note.collection.move',
                params: {
                  id: 47,
                  position: 500,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Collection position:', result.item.position)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', moveCollection)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.note.collection.move(
                bitrix_id=47,
                position=500,
            ).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.collection.move',
                    [
                        'id' => 47,
                        'position' => 500,
                    ]
                );
        
            $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.collection.move',
            {
                id: 47,
                position: 500,
            },
            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.collection.move',
            [
                'id' => 47,
                'position' => 500,
            ]
        );
        
        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.collection.move", b24.Params{
        	"id":       47,
        	"position": 500,
        })
        if err != nil {
        	return fmt.Errorf("note.collection.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"`
        	Name     string `json:"name"`
        	Position int    `json:"position"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Position)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 47,
                    "name": "Policies",
                    "position": 550,
                    "policyLevel": "private",
                    "accessLevel": "full",
                    "state": "live",
                    "isArchived": false,
                    "createdBy": 1,
                    "createdAt": "2026-10-21T15:29:56+03:00",
                    "updatedBy": 1,
                    "updatedAt": "2026-10-21T15:46:14+03:00",
                    "markdownDescription": null
                }
            },
            "time": {
                "start": 1792586774,
                "finish": 1792586774.535677,
                "duration": 0.5356769561767578,
                "processing": 0,
                "date_start": "2026-10-21T15:46:14+03:00",
                "date_finish": "2026-10-21T15:46:14+03:00",
                "operating_reset_at": 1792587360,
                "operating": 0
            }
        }

In this example, position = 500 was passed, but the retained weight is 550: the value was recalculated based on the neighboring knowledge bases with weights 1000 and 100.

Returned Data

Name `type`	Description
result `object`	Object with the knowledge base data
result.item `object`	Knowledge base as retained after the move
result.item.id `integer`	Knowledge base identifier
result.item.name `string`	Knowledge base name
result.item.position `integer`	Retained sort weight of the knowledge base
result.item.policyLevel `string`	Knowledge base access policy code, such as `private` or `portal`
result.item.accessLevel `string`	Current user's access level code for the knowledge base, such as `full`
result.item.state `string`	Knowledge base state: `live` — active, `archived` — archived, `trashed` — in the Recycle Bin
result.item.isArchived `boolean`	`true` — the knowledge base is archived, `false` — not archived
result.item.createdBy `integer`	Identifier of the knowledge base author
result.item.createdAt `datetime`	Creation date and time in ISO 8601 format with a timezone offset
result.item.updatedBy `integer`	Identifier of the last knowledge base editor
result.item.updatedAt `datetime`	Last modification date and time in ISO 8601 format with a timezone offset
result.item.markdownDescription `string` or `null`	Knowledge base description in Markdown
time `time`	Information about the request execution time

Error Handling

HTTP status: 409

{
            "error": {
                "code": "NOTE_COLLECTION_IN_RECYCLE_BIN",
                "message": "This knowledge base is in the Recycle Bin. Restore it to make changes."
            }
        }

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

Knowledge Base in Recycle Bin Error

Error Code: NOTE_COLLECTION_IN_RECYCLE_BIN

HTTP status: 409

Field	Error description	How to Fix
`id`	This knowledge base is in the Recycle Bin. Restore it to make changes	Restore the knowledge base using the note.collection.restore method

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 the "Create Knowledge Bases" permission
`id`	Access denied	The knowledge base is archived. Restore it from the archive using the note.collection.unarchive method

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 knowledge base does not exist or is not accessible 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?

Get Knowledge Bases List

Move Knowledge Base to Recycle Bin

Change Knowledge Base Position note.collection.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

Knowledge Base in Recycle Bin ErrorKnowledge Base in Recycle Bin Error

Access ErrorsAccess Errors

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

Knowledge Base in Recycle Bin Error

Access Errors

Object Not Found Error

Statuses and System Error Codes

Continue Learning