Create a Knowledge Base note.collection.add
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:
noteWho can execute the method: a user with access to the Knowledge base module and the "Create Knowledge Bases" permission
The note.collection.add method creates a new Knowledge base and returns its object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new knowledge base. Object structure description |
Parameter fields
|
Name |
Description |
|
name* |
Knowledge base name. The knowledge base name must not exceed 255 characters |
|
position |
Knowledge base position in the general list. Default: |
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.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Product documentation","position":100}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Product documentation","position":100},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.collection.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CollectionAddResult = {
item: {
id: number
name: string
position: number
policyLevel: string
createdBy: number
updatedBy: number
createdAt: string
updatedAt: string
}
}
try {
const response = await $b24.actions.v3.call.make<CollectionAddResult>({
method: 'note.collection.add',
params: {
fields: {
name: 'Product documentation',
position: 100,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Collection created:', result.item.id, result.item.name)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addCollection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.collection.add',
params: {
fields: {
name: 'Product documentation',
position: 100,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Collection created:', result.item.id, result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCollection)
</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.collection.add',
[
'fields' => [
'name' => 'Product documentation',
'position' => 100,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating collection: ' . $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.add',
{
fields: {
name: 'Product documentation',
position: 100
}
},
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.collection.add',
[
'fields' => [
'name' => 'Product documentation',
'position' => 100
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 42,
"name": "Product documentation",
"position": 100,
"policyLevel": "view",
"createdBy": 1,
"createdAt": "2026-04-20T12:00:00Z",
"updatedBy": 1,
"updatedAt": "2026-04-20T12:00:00Z"
}
},
"time": {
"start": 1780388120,
"finish": 1780388120.245321,
"duration": 0.24532103538513184,
"processing": 0.1812450885772705,
"date_start": "2026-06-16T11:15:20+03:00",
"date_finish": "2026-06-16T11:15:20+03:00",
"operating_reset_at": 1780388720,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the result of knowledge base creation |
|
item |
Created knowledge base object |
|
id |
Identifier of the created knowledge base |
|
name |
Knowledge base name |
|
position |
Knowledge base position in the general list |
|
policyLevel |
Base access policy of the knowledge base |
|
createdBy |
Identifier of the knowledge base author |
|
createdAt |
Date and time of knowledge base creation in UTC |
|
updatedBy |
Identifier of the last knowledge base editor |
|
updatedAt |
Date and time of the last knowledge base change in UTC |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Object validation error",
"validation": [
{
"message": "Mandatory field \"name\" is not filled",
"field": "name"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 |
|
|
Mandatory field |
Add object |
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Mandatory field |
Add |
|
|
Field |
Ensure the provided value is of the correct type |
|
|
Knowledge base name cannot be empty |
Pass a non-empty string in the |
|
|
Knowledge base name must not exceed 255 characters |
Shorten the value of |
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 permissions to create knowledge bases |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |