метод REST scope: note

note.document.add

Создать документ

Кто может выполнять: пользователь с доступом к модулю База знаний и правом «Редактирование» для нужной базы знаний

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.document.add создает новый документ в базе знаний и возвращает его объект.

Параметры

fields object обязательный

Объект с полями нового документа. Описание структуры объекта

Параметр fields

collectionId integer обязательный

Идентификатор базы знаний.

Идентификатор можно получить методом note.collection.list

title string обязательный

Заголовок документа.

Заголовок документа не должен превышать 255 символов

parentId integer необязательный

Идентификатор родительского документа.

Идентификатор можно получить методом note.document.tree.list.

Используйте, если нужно создать вложенный документ. Родительский документ должен принадлежать той же базе знаний, что и collectionId

markdown string необязательный

Начальное содержимое документа в Markdown.

Максимальный размер: 1 048 576 байт

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"collectionId":42,"title":"Глава 1","parentId":10,"markdown":"# Глава 1\n\nТекст документа"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.add

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 77,
            "collectionId": 42,
            "parentId": 10,
            "title": "Глава 1",
            "markdown": "# Глава 1\n\nТекст в Markdown...",
            "position": 5,
            "createdBy": 1,
            "updatedBy": 1,
            "createdAt": "2026-04-20T12:00:00Z",
            "updatedAt": "2026-04-20T12:00:00Z"
        }
    },
    "time": {
        "start": 1780390800,
        "finish": 1780390800.214321,
        "duration": 0.21432113647460938,
        "processing": 0.17321419715881348,
        "date_start": "2026-06-16T12:00:00+03:00",
        "date_finish": "2026-06-16T12:00:00+03:00",
        "operating_reset_at": 1780391400,
        "operating": 0
    }
}

Возвращаемые данные

result object

Объект с результатом создания документа

item object

Объект созданного документа

id integer

Идентификатор созданного документа

collectionId integer

Идентификатор базы знаний

parentId integer

Идентификатор родительского документа или null

title string

Заголовок документа

markdown string

Содержимое документа в Markdown

position integer

Позиция документа среди соседних страниц

createdBy integer

Идентификатор автора документа

updatedBy integer

Идентификатор последнего редактора документа

createdAt datetime

Дата и время создания документа в UTC

updatedAt datetime

Дата и время последнего изменения документа в UTC

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Не заполнено обязательное поле \"title\"",
                "field": "title"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
fields Обязательное поле fields не указано Добавьте объект fields в тело запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.