Change Folder in landing.site.updateFolder

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: landing

Who can execute the method: a user with "edit" access permission for the site

The method landing.site.updateFolder updates the parameters of a site folder.

Method Parameters

Required parameters are marked with *

Name
type

Description

scope
string

Internal scope of the landing. It is not related to the REST scope landing in the method name.

The value of scope must correspond to the type of site (detailed description)

siteId*
integer

Identifier of the site to which the folder belongs.

The site identifier can be obtained using the landing.site.getList method

folderId*
integer

Identifier of the folder to be updated.

The folder identifier can be obtained using the landing.site.getFolders method

fields*
object

Set of fields to update the folder (detailed description)

Parameter fields

Required parameters are marked with *

Name
type

Description

TITLE
string

Title of the folder

CODE
string

Symbolic code of the folder for the URL. The code cannot contain the character /.

If the parameter is not provided, the current value of CODE for the folder is used

PARENT_ID
integer

Identifier of the parent folder.

If the value is 0, null, empty, or the parameter is not provided, the folder is moved to the root of the site

INDEX_ID
integer

Identifier of the index page of the folder

ACTIVE
string

Active flag for the folder Y/N

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1817,
            "folderId": 736,
            "fields": {
              "TITLE": "Services Catalog",
              "CODE": "services-catalog",
              "PARENT_ID": 0,
              "INDEX_ID": 987,
              "ACTIVE": "Y"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.updateFolder.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1817,
            "folderId": 736,
            "fields": {
              "TITLE": "Services Catalog",
              "CODE": "services-catalog",
              "PARENT_ID": 0,
              "INDEX_ID": 987,
              "ACTIVE": "Y"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.updateFolder.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.site.updateFolder',
        		{
        			siteId: 1817,
        			folderId: 736,
        			fields: {
        				TITLE: 'Services Catalog',
        				CODE: 'services-catalog',
        				PARENT_ID: 0,
        				INDEX_ID: 987,
        				ACTIVE: 'Y'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.updateFolder',
                    [
                        'siteId' => 1817,
                        'folderId' => 736,
                        'fields' => [
                            'TITLE' => 'Services Catalog',
                            'CODE' => 'services-catalog',
                            'PARENT_ID' => 0,
                            'INDEX_ID' => 987,
                            'ACTIVE' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating folder: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.site.updateFolder',
            {
                siteId: 1817,
                folderId: 736,
                fields: {
                    TITLE: 'Services Catalog',
                    CODE: 'services-catalog',
                    PARENT_ID: 0,
                    INDEX_ID: 987,
                    ACTIVE: 'Y'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.updateFolder',
            [
                'siteId' => 1817,
                'folderId' => 736,
                'fields' => [
                    'TITLE' => 'Services Catalog',
                    'CODE' => 'services-catalog',
                    'PARENT_ID' => 0,
                    'INDEX_ID' => 987,
                    'ACTIVE' => 'Y',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1773291230,
                "finish": 1773291230.313858,
                "duration": 0.3138580322265625,
                "processing": 0,
                "date_start": "2026-03-12T07:53:50+01:00",
                "date_finish": "2026-03-12T07:53:50+01:00",
                "operating_reset_at": 1773291830,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Returns true if the folder was successfully updated

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Site not found or access to it is denied."
        }
        

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

MISSING_PARAMS

Required parameter siteId, folderId, or fields is missing

ACCESS_DENIED

Site not found or access to it is denied

FOLDER_IS_NOT_UNIQUE

A folder with this name already exists

SLASH_IS_NOT_ALLOWED

Slash is not allowed in the folder address

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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