метод REST scope: note

note.file.add

Загрузить файл в документ

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

Описание

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

Метод note.file.add загружает файл в документ и возвращает объект файла.

Метод не вставляет вложение в содержимое документа автоматически. Он только сохраняет файл и привязывает его к документу.

Параметры

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

Идентификатор документа, к которому нужно привязать файл.

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

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

Имя файла с расширением.

Допустимые расширения: png, jpg, jpeg, gif, webp, svg, pdf, txt, md, csv, doc, docx, xls, xlsx, ppt, pptx, mp4, webm, mov

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

Бинарное содержимое файла в кодировке Base64.

Максимальный размер файла зависит от настройки main.max_file_size в Битрикс24. Если она не задана, используется ограничение 25 МиБ (25 * 1024 * 1024 байт)

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":77,"fileName":"diagram.png","fileContent":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.add

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 5001,
            "documentId": 77,
            "name": "diagram.png",
            "size": 6321,
            "mimeType": "image/png",
            "assetType": "image",
            "assetMarkdown": "[[image fileId=5001]]"
        }
    },
    "time": {
        "start": 1780392000,
        "finish": 1780392000.284521,
        "duration": 0.28452086448669434,
        "processing": 0.2413930892944336,
        "date_start": "2026-06-16T12:20:00+03:00",
        "date_finish": "2026-06-16T12:20:00+03:00",
        "operating_reset_at": 1780392600,
        "operating": 0
    }
}

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

result object

Объект с результатом загрузки файла

item object

Объект загруженного файла

id integer

Идентификатор загруженного файла

documentId integer

Идентификатор документа, к которому привязан файл

name string

Имя файла

size integer

Размер файла в байтах

mimeType string

MIME-тип файла

assetType string

Тип вложения для Markdown-блока

assetMarkdown string

Готовый Markdown-блок для вставки файла в документ через note.document.update.

Перед вставкой изображения или видео блок можно дополнить параметрами масштаба и выравнивания. Подробнее о параметрах читайте в описании поля markdown метода note.document.update

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "invalid base64 payload",
                "field": "fileContent"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
documentId fileName fileContent Обязательное поле #FIELD# не указано Добавьте указанное поле в тело запроса
documentId fileName fileContent В поле #FIELD# требуется тип данных #TYPE# для такого запроса Убедитесь, что передаваемое значение нужного типа
fileContent Передано некорректное содержимое Base64 Проверьте, что fileContent содержит непустую Base64-строку без поврежденных символов
fileContent Не удалось сохранить файл Повторите запрос позже или проверьте корректность передаваемых данных

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

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