Create a Subfolder disk.folder.addSubFolder

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: disk

Who can execute the method: a user with "Add" or "Edit" access permission for the required folder

The method disk.folder.addSubFolder creates a subfolder.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the parent folder.

The identifier can be obtained using the method disk.storage.getChildren if the folder is in the root of the storage, and using the method disk.folder.getChildren if the folder is in another folder

data*
object

Subfolder parameters (detailed description)

rights
array

An array of access permissions for the folder. Each item contains:

  • ACCESS_CODE — a non-empty string of up to 50 characters containing the access recipient code, for example, U35
  • TASK_ID — an integer identifier of an existing access level
  • NEGATIVE — an optional boolean flag for a deny permission. String values true, yes, and on specify a deny permission

The list of available TASK_ID identifiers can be obtained using the disk.rights.getTasks method.

Additional fields, including DOMAIN and OBJECT_ID, are ignored

data Parameter

Name
type

Description

NAME*
string

Subfolder name. The maximum length is 255 characters. The name must not contain characters prohibited in file names

You can set permissions when creating a folder using the rights parameter. To grant access after creating the folder, use the disk.folder.shareToUser method

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8907,"data":{"NAME":"Folder in Folder"},"rights":[{"TASK_ID":71,"ACCESS_CODE":"U1271"}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.addSubFolder
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8907,"data":{"NAME":"Folder in Folder"},"rights":[{"TASK_ID":71,"ACCESS_CODE":"U1271"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.folder.addSubFolder
        
// 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 AddSubfolderResult = {
          ID: number
          NAME: string
          CODE: string | null
          STORAGE_ID: string
          TYPE: string
          REAL_OBJECT_ID: number
          PARENT_ID: string
          DELETED_TYPE: number
          CREATE_TIME: ISODate
          UPDATE_TIME: ISODate
          DELETE_TIME: ISODate | null
          CREATED_BY: string
          UPDATED_BY: string
          DELETED_BY: string | null
          DETAIL_URL: string | null
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AddSubfolderResult>({
            method: 'disk.folder.addSubFolder',
            params: {
              id: 8907,
              data: {
                NAME: 'Subfolder name',
              },
              rights: [
                {
                  TASK_ID: 71,
                  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('Created subfolder:', result.ID, result.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 addSubfolder() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'disk.folder.addSubFolder',
                params: {
                  id: 8907,
                  data: {
                    NAME: 'Subfolder name',
                  },
                  rights: [
                    {
                      TASK_ID: 71,
                      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('Created subfolder:', result.ID, result.NAME)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addSubfolder)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.disk.folder.add_sub_folder(
                bitrix_id=8907,
                data={
                    "NAME": "Folder inside a folder",
                },
                rights=[
                    {
                        "TASK_ID": 71,
                        "ACCESS_CODE": "U1271",
                    },
                ],
            ).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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.folder.addSubFolder',
                    [
                        'id' => 8907,
                        'data' => [
                            'NAME' => 'Folder in Folder'
                        ],
                        'rights' => [
                            [
                                'TASK_ID' => 71,
                                'ACCESS_CODE' => 'U1271'
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding subfolder: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.folder.addSubFolder",
            {
                id: 8907,
                data: {
                    NAME: 'Folder in Folder'
                },
                rights: [
                    {
                        TASK_ID: 71,
                        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.addSubFolder',
            [
                'id' => 8907,
                'data' => [
                    'NAME' => 'Folder in Folder'
                ],
                'rights' => [
                    [
                        'TASK_ID' => 71,
                        'ACCESS_CODE' => 'U1271'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "disk.folder.addSubFolder", b24.Params{
            "id": 8907,
            "data": b24.Params{
        	    "NAME": "Folder in Folder",
            },
            "rights": []b24.Params{
        	    {
        		    "TASK_ID":     71,
        		    "ACCESS_CODE": "U1271",
        	    },
            },
        })
        if err != nil {
        	return fmt.Errorf("disk.folder.addSubFolder: %w", err)
        }
        
        var item struct {
        	ID           b24.ID `json:"ID"`
        	Name         string `json:"NAME"`
        	StorageID    b24.ID `json:"STORAGE_ID"`
        	Type         string `json:"TYPE"`
        	RealObjectID b24.ID `json:"REAL_OBJECT_ID"`
        	ParentID     b24.ID `json:"PARENT_ID"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": 8930,
                "NAME": "Folder in Folder",
                "CODE": null,
                "STORAGE_ID": "1357",
                "TYPE": "folder",
                "REAL_OBJECT_ID": 8930,
                "PARENT_ID": "8907",
                "DELETED_TYPE": 0,
                "CREATE_TIME": "2026-01-13T11:20:40+01:00",
                "UPDATE_TIME": "2026-01-13T11:20:40+01:00",
                "DELETE_TIME": null,
                "CREATED_BY": "1269",
                "UPDATED_BY": "1269",
                "DELETED_BY": null,
                "DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/path/Folder/Folder in Folder"
            },
            "time": {
                "start": 1768292440,
                "finish": 1768292440.894889,
                "duration": 0.8948891162872314,
                "processing": 0,
                "date_start": "2026-01-13T11:20:40+01:00",
                "date_finish": "2026-01-13T11:20:40+01:00",
                "operating_reset_at": 1768293040,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object containing data about the created folder

ID
integer

Identifier of the folder

NAME
string

Name of the folder

CODE
string

Symbolic code of the folder

STORAGE_ID
integer

Identifier of the storage where the folder is located

TYPE
enum

Type of the object

REAL_OBJECT_ID
integer

Identifier of the object

PARENT_ID
integer

Identifier of the parent folder

DELETED_TYPE
enum

Deletion status of the object. Possible values:

  • 0 — not deleted
  • 3 — in the trash
  • 4 — deleted along with the parent folder

CREATE_TIME
datetime

Date and time of folder creation

UPDATE_TIME
datetime

Date and time of the last update of the folder

DELETE_TIME
datetime

Date and time of moving the folder to the trash

CREATED_BY
integer

Identifier of the user who created the folder

UPDATED_BY
integer

Identifier of the user who made the last change

DELETED_BY
integer

Identifier of the user who deleted the folder

DETAIL_URL
string | null

Link to open the folder in the interface. For folders from app storages and storages of other modules, such as chats or CRM, it is null

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400 or 403

{
            "error":"ERROR_ARGUMENT",
            "error_description":"Invalid value of parameter {Parameter #1}"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

ERROR_ARGUMENT

Invalid value of parameter

Required parameter data is missing

400

DISK_BASE_SERVICE_22001

Error: required parameter NAME (DISK_BASE_SERVICE_22001)

Required field NAME is missing from the data object or an empty value was provided

400

DISK_MO_28000

The name contains invalid characters

NAME contains characters prohibited in file names

400

DISK_MO_28000

The maximum length for the "Name" field has been exceeded: 255

The NAME length exceeds 255 characters

400

DISK_OBJ_22000

A folder with this name already exists

A folder with this name already exists

400

ERROR_NOT_FOUND

Could not find entity with id X

The folder with the specified id was not found

400

Empty value

Invalid format: Right N should be array

The rights item at index N is not an array

400

Empty value

Invalid format: Right N should contain ACCESS_CODE and TASK_ID

The rights item at index N does not contain ACCESS_CODE or TASK_ID

400

Empty value

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

ACCESS_CODE is not a string or is an empty string

400

Empty value

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

ACCESS_CODE exceeds 50 characters

400

Empty value

Invalid format: Right N should contain TASK_ID as integer

TASK_ID is not an integer

400

Empty value

Invalid format: Right N should contain known TASK_ID

The access level with the specified TASK_ID was not found

400

Empty value

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

NEGATIVE cannot be converted to a boolean value

403

ACCESS_DENIED

Access denied!

Insufficient permissions to create the folder or change access permissions

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