Create a Folder in the Root of the Storage disk.storage.addfolder

Scope: disk

Who can execute the method: user with "Add" access permission for the required storage

The method disk.storage.addfolder creates a folder in the root of the storage.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the storage.

The identifier can be obtained using the method disk.storage.getlist

data*
array

Array with the field NAME, where NAME is the name of the new folder

rights
array

Array of access permissions for the folder in the format {"TASK_ID": 42, "ACCESS_CODE": "U35"}, where

  • TASK_ID — identifier of the access level
  • ACCESS_CODE — access code consisting of the user's or department's letter code and identifier

User categories:

  • U — user
  • * — all users
  • D — all department employees
  • DR — all department employees with subdivisions

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

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1357,"data":{"NAME":"New Folder"},"rights":[{"TASK_ID":71,"ACCESS_CODE":"U1271"}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.storage.addfolder
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1357,"data":{"NAME":"New Folder"},"rights":[{"TASK_ID":71,"ACCESS_CODE":"U1271"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.storage.addfolder
        
try
        {
            const response = await $b24.callMethod(
                'disk.storage.addfolder',
                {
                    id: 1357,
                    data: {
                        NAME: 'New Folder',
                    },
                    rights: [
                        {
                            TASK_ID: 71,
                            ACCESS_CODE: 'U1271'
                        }
                    ]
                }
            );
            
            const result = response.getData().result;
            console.log('Created folder with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.storage.addfolder',
                    [
                        'id' => 1357,
                        'data' => [
                            'NAME' => 'New 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 folder: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.storage.addfolder",
            {
                id: 1357,
                data: {
                    NAME: 'New 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.storage.addfolder',
            [
                'id' => 1357,
                'data' => [
                    'NAME' => 'New Folder'
                ],
                'rights' => [
                    [
                        'TASK_ID' => 71,
                        'ACCESS_CODE' => 'U1271'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP status: 200

{
            "result": {
                "ID": 9031,
                "NAME": "New Folder",
                "CODE": null,
                "STORAGE_ID": "1357",
                "TYPE": "folder",
                "REAL_OBJECT_ID": 9031,
                "PARENT_ID": "8875",
                "DELETED_TYPE": 0,
                "CREATE_TIME": "2026-01-28T17:23:11+02:00",
                "UPDATE_TIME": "2026-01-28T17:23:11+02: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/New Folder"
            },
            "time": {
                "start": 1769610191,
                "finish": 1769610191.803601,
                "duration": 0.8036010265350342,
                "processing": 0,
                "date_start": "2026-01-28T17:23:11+02:00",
                "date_finish": "2026-01-28T17:23:11+02:00",
                "operating_reset_at": 1769610791,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

Array with 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

Link to open the folder in the interface

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

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

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Value

ERROR_ARGUMENT

Invalid value of parameter

Required field NAME not provided in the data array

DISK_OBJ_22000

A folder with this name already exists

A folder with this name already exists

ERROR_NOT_FOUND

Could not find entity with id X

Storage with the specified id not found

ACCESS_DENIED

Access denied

Insufficient permissions to create the folder

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning