Publish a Website Folder landing.site.publicationFolder
Scope:
landingWho can execute the method: a user with "publication" access permission for the website to which the folder belongs.
The method landing.site.publicationFolder publishes a website folder along with its chain of parent folders.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
folderId* |
The identifier of the folder. The folder identifier can be obtained using the landing.site.getFolders method. |
|
mark |
Publication flag. It is recommended to use landing.site.unPublicFolder for unpublishing. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"folderId": 737,
"mark": true
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.publicationFolder.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"folderId": 737,
"mark": true,
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.site.publicationFolder.json"
try
{
const response = await $b24.callMethod(
'landing.site.publicationFolder',
{
folderId: 737,
mark: true
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.site.publicationFolder',
[
'folderId' => 737,
'mark' => true,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . var_export($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error publishing folder: ' . $e->getMessage();
}
BX24.callMethod(
'landing.site.publicationFolder',
{
folderId: 737,
mark: true
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.site.publicationFolder',
[
'folderId' => 737,
'mark' => true,
]
);
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": 1773285926,
"finish": 1773285926.538981,
"duration": 0.5389809608459473,
"processing": 0,
"date_start": "2026-03-12T06:25:26+01:00",
"date_finish": "2026-03-12T06:25:26+01:00",
"operating_reset_at": 1773286526,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Returns |
|
time |
Information about the execution time of the request. |
Error Handling
HTTP Status: 400
{
"error": "ACCESS_DENIED",
"error_description": "Folder not found or access denied."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Required parameter |
|
|
Folder not found, deleted, or access denied. |
|
|
Data type error in method call parameters. |
|
|
Internal error during method execution. |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Add Folder to Site landing.site.addFolder
- Change Folder in landing.site.updateFolder
- Get Site Folders landing.site.getFolders
- Mark Folder as Deleted landing.account.markFolderDelete
- Restore Folder from Recycle Bin landing.site.markFolderUnDelete
- Unpublishing a Website Folder landing.site.unPublicFolder