Загрузить новый файл в указанную папку disk.folder.uploadFile

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: disk

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

Метод disk.folder.uploadFile загружает новый файл в указанную папку.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

Идентификатор можно получить с помощью метода disk.storage.getChildren, если папка находится в корне хранилища, и с помощью метода disk.folder.getChildren, если папка находится в другой папке

data*
array

Массив с полем NAME, где NAME — имя файла.

Необязателен, если файл загружается не напрямую, а через URL. Пример загрузки файла через URL ниже

fileContent
array

Массив из имени файла и строки с Base64.

Если параметр не передан, метод не загружает файл, а возвращает URL для загрузки UploadUrl и имя поля формы field

rights
array

Массив прав доступа на загружаемый файл. Каждый элемент содержит:

  • ACCESS_CODE — непустая строка длиной до 50 символов с кодом получателя права, например U35
  • TASK_ID — целочисленный идентификатор существующего уровня доступа
  • NEGATIVE — необязательный логический признак запрещающего права. Значения true, yes и on, переданные строкой, соответствуют запрещающему праву

Категории пользователей:

  • U — пользователь
  • * — все пользователи
  • D — все сотрудники отдела
  • DR — все сотрудники отдела с подотделами

Список доступных идентификаторов TASK_ID для установки прав можно получить методом disk.rights.getTasks.

Дополнительные поля, включая DOMAIN и OBJECT_ID, не учитываются

generateUniqueName
boolean

Генерация уникального имени файла, если файл с таким именем уже существует. Например, file (1).docx.

Возможные значения:

  • true — генерировать
  • false — не генерировать

По умолчанию — false

Примеры кода

Как использовать примеры в документации

Прямая загрузка файла

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":8930,"data":{"NAME":"test.png"},"fileContent":["test.png","iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII="],"generateUniqueName":true,"rights":[{"TASK_ID":75,"ACCESS_CODE":"U1271"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.uploadFile
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":8930,"data":{"NAME":"test.png"},"fileContent":["test.png","iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII="],"generateUniqueName":true,"rights":[{"TASK_ID":75,"ACCESS_CODE":"U1271"}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/disk.folder.uploadFile
// 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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type UploadFileResult = {
  ID: number
  NAME: string
  CODE: string | null
  STORAGE_ID: string
  TYPE: string
  PARENT_ID: string
  DELETED_TYPE: number
  GLOBAL_CONTENT_VERSION: number
  FILE_ID: number
  SIZE: string
  CREATE_TIME: ISODate
  UPDATE_TIME: ISODate
  DELETE_TIME: ISODate | null
  CREATED_BY: string
  UPDATED_BY: string
  DELETED_BY: string | null
  DOWNLOAD_URL: string
  DETAIL_URL: string
}

try {
  const response = await $b24.actions.v2.call.make<UploadFileResult>({
    method: 'disk.folder.uploadFile',
    params: {
      id: 8930,
      data: {
        NAME: 'test.png',
      },
      fileContent: [
        'test.png',
        'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII=',
      ],
      generateUniqueName: true,
      rights: [
        {
          TASK_ID: 75,
          ACCESS_CODE: 'U1271',
        },
      ],
    },
    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('Uploaded file:', result.ID, result.NAME, result.DOWNLOAD_URL)
  }
} 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 uploadFile() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'disk.folder.uploadFile',
        params: {
          id: 8930,
          data: {
            NAME: 'test.png',
          },
          fileContent: [
            'test.png',
            'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII=',
          ],
          generateUniqueName: true,
          rights: [
            {
              TASK_ID: 75,
              ACCESS_CODE: 'U1271',
            },
          ],
        },
        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('Uploaded file:', result.ID, result.NAME, result.DOWNLOAD_URL)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', uploadFile)
</script>
  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.disk.folder.uploadfile(
            bitrix_id=8930,
        ).response
        result = bitrix_response.result
        print(result)
    except BitrixAPIError as error:
        print(
            "Ошибка Bitrix API",
            f"error: {error.error}",
            f"error_description: {error.error_description}",
            sep="\n",
        )
    except BitrixSDKException as error:
        print(f"Ошибка Bitrix SDK: {error.message}")
    except Exception as error:
        print(f"Непредвиденная ошибка: {error}")
    
try {
    $response = $b24Service
        ->core
        ->call(
            'disk.folder.uploadFile',
            [
                'id' => 8930,
                'data' => [
                    'NAME' => 'test.png'
                ],
                'fileContent' => [
                    'test.png',
                    'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII='
                ],
                'generateUniqueName' => true,
                'rights' => [
                    [
                        'TASK_ID' => 75,
                        'ACCESS_CODE' => 'U1271'
                    ]
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error uploading file: ' . $e->getMessage();
}
BX24.callMethod(
    "disk.folder.uploadFile",
    {
        id: 8930,
        data: {
            NAME: "test.png"
        },
        fileContent: [
        'test.png',
        'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII=',
        ],
        generateUniqueName: true,
        rights: [
            {
                TASK_ID: 75,
                ACCESS_CODE: 'U1271'
            }
        ]
    },
    function (result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'disk.folder.uploadFile',
    [
        'id' => 8930,
        'data' => [
            'NAME' => 'test.png'
        ],
        'fileContent' => [
            'test.png',
            'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII='
        ],
        'generateUniqueName' => true,
        'rights' => [
            [
                'TASK_ID' => 75,
                'ACCESS_CODE' => 'U1271'
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "disk.folder.uploadFile", b24.Params{
	"id": 8930,
	"data": b24.Params{
		"NAME": "test.png",
	},
	"fileContent":        []string{"test.png", "iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII="},
	"generateUniqueName": true,
	"rights": []b24.Params{
		{
			"TASK_ID":     75,
			"ACCESS_CODE": "U1271",
		},
	},
})
if err != nil {
	return fmt.Errorf("disk.folder.uploadFile: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

Загрузка файла через URL

  1. Вызовите метод и передайте только ID папки.

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"id":8930}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.uploadFile
    
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"id":8930,"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/disk.folder.uploadFile
    
    // 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 GetUploadUrlResult = {
      field: string
      uploadUrl: string
    }
    
    try {
      const response = await $b24.actions.v2.call.make<GetUploadUrlResult>({
        method: 'disk.folder.uploadFile',
        params: {
          id: 8930,
        },
        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('Upload URL:', result.uploadUrl, 'field:', result.field)
      }
    } 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 getUploadUrl() {
        try {
          // Initialize the SDK inside a Bitrix24 frame
          const $b24 = await B24Js.initializeB24Frame()
    
          const response = await $b24.actions.v2.call.make({
            method: 'disk.folder.uploadFile',
            params: {
              id: 8930,
            },
            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('Upload URL:', result.uploadUrl, 'field:', result.field)
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
      }
    
      document.addEventListener('DOMContentLoaded', getUploadUrl)
    </script>
    
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.disk.folder.uploadfile(
            bitrix_id=8930,
        ).response
        result = bitrix_response.result
        print(result)
    except BitrixAPIError as error:
        print(
            "Ошибка Bitrix API",
            f"error: {error.error}",
            f"error_description: {error.error_description}",
            sep="\n",
        )
    except BitrixSDKException as error:
        print(f"Ошибка Bitrix SDK: {error.message}")
    except Exception as error:
        print(f"Непредвиденная ошибка: {error}")
    
    try {
        $response = $b24Service
            ->core
            ->call(
                'disk.folder.uploadFile',
                [
                    'id' => 8930
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error uploading file: ' . $e->getMessage();
    }
    
    BX24.callMethod(
        "disk.folder.uploadFile",
        {
            id: 8930
        },
        function (result)
        {
            if (result.error())
                console.error(result.error());
            else
                console.dir(result.data());
        }
    );
    
    require_once('crest.php');
    
    $result = CRest::call(
        'disk.folder.uploadFile',
        [
            'id' => 8930
        ]
    );
    
    echo '<PRE>';
    print_r($result);
    echo '</PRE>';
    
    // client и ctx уже созданы — см. раздел «SDK для Go»
    res, err := client.Core().Call(ctx, "disk.folder.uploadFile", b24.Params{
    	"id": 8930,
    })
    if err != nil {
    	return fmt.Errorf("disk.folder.uploadFile: %w", err)
    }
    
    // Ответ приходит как json.RawMessage — разберите его
    // в структуру под форму ответа, показанную ниже на этой странице.
    fmt.Printf("%s\n", res.Result)
    
  2. В ответ вы получите URL для загрузки UploadUrl и имя поля формы field.

    "result": {
            "field": "file",
            "uploadUrl": "https://test.bitrix24.ru/rest/upload.json?auth=929b78690000071b006e2cf2000004f5000007dde54ef79d3b6e5c447d8f8a714563bd&token=disk%7CaWQ9ODkzMCZnZW5lcmF0ZVVuaXF1ZU5hbWU9MCZfPU4zS0pqUFJiVDFSengzUmpUaTVPcGM4R1VQTlFkTWU0%7CInVwbG9hZHxkaXNrfGFXUTlPRGt6TUNablpXNWxjbUYwWlZWdWFYRjFaVTVoYldVOU1DWmZQVTR6UzBwcVVGSmlWREZTZW5nelVtcFVhVFZQY0dNNFIxVlFUbEZrVFdVMHw5MjliNzg2OTAwMDAwNzFiMDA2ZTJjZjIwMDAwMDRmNTAwMDAwN2RkZTU0ZWY3OWQzYjZlNWM0NDdkOGY4YTcxNDU2M2JkIg%3D%3D.OHwSxVni%2FKX9Pw%2FyMzpfR974ImX5bC0sigTqA0UTCp8%3D"
            },
        "time": {
            "start": 1769511710,
            "finish": 1769511710.411701,
            "duration": 0.411700963973999,
            "processing": 0,
            "date_start": "2026-01-27T14:01:50+03:00",
            "date_finish": "2026-01-27T14:01:50+03:00",
            "operating_reset_at": 1769512310,
            "operating": 0
        }
    
  3. Отправьте файл на полученный адрес UploadUrl с помощью POST-запроса, используя тип multipart/form-data. Имя поля для файла внутри этого запроса должно совпадать со значением параметра field из ответа.

    http --form POST "https://test.bitrix24.ru/rest/upload.json?auth=929b78690000071b006e2cf2000004f5000007dde54ef79d3b6e5c447d8f8a714563bd&token=disk%7CaWQ9ODkzMCZnZW5lcmF0ZVVuaXF1ZU5hbWU9MCZfPU4zS0pqUFJiVDFSengzUmpUaTVPcGM4R1VQTlFkTWU0%7CInVwbG9hZHxkaXNrfGFXUTlPRGt6TUNablpXNWxjbUYwWlZWdWFYRjFaVTVoYldVOU1DWmZQVTR6UzBwcVVGSmlWREZTZW5nelVtcFVhVFZQY0dNNFIxVlFUbEZrVFdVMHw5MjliNzg2OTAwMDAwNzFiMDA2ZTJjZjIwMDAwMDRmNTAwMDAwN2RkZTU0ZWY3OWQzYjZlNWM0NDdkOGY4YTcxNDU2M2JkIg%3D%3D.OHwSxVni%2FKX9Pw%2FyMzpfR974ImX5bC0sigTqA0UTCp8%3D" file@/path/to/file.png
    
  4. В случае успеха сервер вернет массив с данными о загруженном файле.

Загрузка файла через URL на PHP

<?php
require_once (__DIR__.'/crest.php');

$path = __DIR__ . '/pic.jpg';
$folderId = 1;

$result = [];
if (file_exists($path))
{
    $file = CRest::call(
        'disk.folder.uploadFile',
        [
            'id' => $folderId,
        ]
    );
    if (!empty($file['result']['uploadUrl']))
    {
        $info = pathinfo($path);
        if ($info['basename'])
        {
            $delimiter = '-------------' . uniqid('', true);
            $name = $info['basename'];
            $mime = mime_content_type($path);
            $content = file_get_contents($path);

            $body = '--' . $delimiter. "\r\n";
            $body .= 'Content-Disposition: form-data; name="file"';
            $body .= '; filename="' . $name . '"' . "\r\n";
            $body .= 'Content-Type: ' . $mime . "\r\n\r\n";
            $body .= $content . "\r\n";
            $body .= "--" . $delimiter . "--\r\n";

            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, $file['result']['uploadUrl']);
            curl_setopt($ch, CURLOPT_POST, 1);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
            curl_setopt(
                $ch,
                CURLOPT_HTTPHEADER,
                [
                    'Content-Type: multipart/form-data; boundary=' . $delimiter,
                    'Content-Length: ' . strlen($body),
                ]
            );
            $out = curl_exec($ch);
            try
            {
                $result = json_decode($out, true, 512, JSON_THROW_ON_ERROR);
            }
            catch (JsonException $e)
            {
                $result = [
                    'error' => $e->getMessage(),
                ];
            }
        }
    }
}

echo '<pre>';
    print_r($result);
echo '</pre>';
?>

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "ID": 9011,
        "NAME": "test.png",
        "CODE": null,
        "STORAGE_ID": "1357",
        "TYPE": "file",
        "PARENT_ID": "8930",
        "DELETED_TYPE": 0,
        "GLOBAL_CONTENT_VERSION": 1,
        "FILE_ID": 32877,
        "SIZE": "1679",
        "CREATE_TIME": "2026-01-27T13:06:55+03:00",
        "UPDATE_TIME": "2026-01-27T13:06:55+03:00",
        "DELETE_TIME": null,
        "CREATED_BY": "1269",
        "UPDATED_BY": "1269",
        "DELETED_BY": null,
        "DOWNLOAD_URL": "https://test.bitrix24.ru/rest/download.json?auth=929b78690000071b006e2cf2000004f5000007dde54ef79d3b6e5c447d8f8a714563bd&token=disk%7CaWQ9OTAxMSZfPUFKQTNyWWVLZkxVdEw0VDRjY1QyOGpyN1NqYXZneFRI%7CImRvd25sb2FkfGRpc2t8YVdROU9UQXhNU1pmUFVGS1FUTnlXV1ZMWmt4VmRFdzBWRFJqWTFReU9HcHlOMU5xWVhabmVGUkl8OTI5Yjc4NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDdkZGU1NGVmNzlkM2I2ZTVjNDQ3ZDhmOGE3MTQ1NjNiZCI%3D.XX%2BUFpxsl2eoLuCwolEaMKsrAJ5IIpIPmzg1j6QOuE0%3D",
        "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/file/Папка/Папка в папке/test.png"
    },
    "time": {
        "start": 1769508415,
        "finish": 1769508416.040339,
        "duration": 1.0403389930725098,
        "processing": 1,
        "date_start": "2026-01-27T13:06:55+03:00",
        "date_finish": "2026-01-27T13:06:56+03:00",
        "operating_reset_at": 1769509015,
        "operating": 0.7169051170349121
    }
}

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

Название
тип

Описание

result
array

Массив с полями файла

ID
integer

Идентификатор файла

NAME
string

Имя файла

CODE
string

Символьный код файла

STORAGE_ID
integer

Идентификатор хранилища, в котором находится файл

TYPE
enum

Тип объекта

PARENT_ID
integer

Идентификатор родительской папки

DELETED_TYPE
enum

Статус удаления объекта. Возможные значения:

  • 0 — не удален
  • 3 — в корзине
  • 4 — удален вместе с родительской папкой

GLOBAL_CONTENT_VERSION
integer

Инкрементальный счетчик версии файла

FILE_ID
integer

Внутреннее значение идентификатора файла

SIZE
integer

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

CREATE_TIME
datetime

Дата и время создания файла

UPDATE_TIME
datetime

Дата и время последнего обновления файла

DELETE_TIME
datetime

Дата и время переноса файла в корзину

CREATED_BY
integer

Идентификатор пользователя, создавшего файл

UPDATED_BY
integer

Идентификатор пользователя, внесшего последнее изменение

DELETED_BY
integer

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

DOWNLOAD_URL
string

Ссылка для скачивания файла

DETAIL_URL
string

Ссылка для открытия файла в интерфейсе

time
time

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

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

HTTP-статус: 400 или 403

{
    "error":"ERROR_NOT_FOUND",
    "error_description":"Could not find entity with id `X`"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

ERROR_ARGUMENT

Invalid value of parameter

Не указан обязательный параметр id

400

ERROR_NOT_FOUND

Could not find entity with id X

Папка с указанным id не найдена

400

DISK_BASE_SERVICE_22001

Error: required parameter NAME (DISK_BASE_SERVICE_22001)

Не указан обязательный параметр NAME в массиве data

400

ERROR_COULD_NOT_SAVE_FILE

Could not save file

Не удалось сохранить файл. Проверьте свободное место на Диске и корректность кодировки данных

400

Пустое значение

Invalid format: Right N should be array

Элемент rights с индексом N передан не в виде массива

400

Пустое значение

Invalid format: Right N should contain ACCESS_CODE and TASK_ID

В элементе rights с индексом N отсутствует ACCESS_CODE или TASK_ID

400

Пустое значение

Invalid format: Right N should contain ACCESS_CODE as not empty string

ACCESS_CODE передан не строкой или содержит пустую строку

400

Пустое значение

Invalid format: Right N should contain ACCESS_CODE not longer than 50 characters

Длина ACCESS_CODE превышает 50 символов

400

Пустое значение

Invalid format: Right N should contain TASK_ID as integer

TASK_ID не является целым числом

400

Пустое значение

Invalid format: Right N should contain known TASK_ID

Уровень доступа с указанным TASK_ID не найден

400

Пустое значение

Invalid format: Right N should contain NEGATIVE as 0 or 1

NEGATIVE нельзя преобразовать в логическое значение

403

ACCESS_DENIED

Access denied!

Недостаточно прав для добавления файла или изменения прав доступа

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение