Delete Site landing.site.delete
Scope:
landingWho can execute the method: a user with "delete" access permission for sites
The method landing.site.delete removes only an empty site without pages.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Site identifier The site identifier can be obtained using the method landing.site.getList or from the result of the method landing.site.add |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 206
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.delete.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 206,
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.site.delete.json"
try
{
const response = await $b24.callMethod(
'landing.site.delete',
{
id: 206
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.site.delete',
[
'id' => 206,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . var_export($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting site: ' . $e->getMessage();
}
BX24.callMethod(
'landing.site.delete',
{
id: 206
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.site.delete',
[
'id' => 206,
]
);
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": 1773178832,
"finish": 1773178832.235556,
"duration": 0.23555588722229004,
"processing": 0,
"date_start": "2026-03-11T00:40:32+01:00",
"date_finish": "2026-03-11T00:40:32+01:00",
"operating_reset_at": 1773179432,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the deletion, returns |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "SITE_IS_NOT_EMPTY",
"error_description": "The site contains pages."
}
|
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 |
|
|
Insufficient permissions to delete the site |
|
|
Deleting the site is not available when a domain provider is connected in Bitrix24 |
|
|
The site has at least one page, including pages in the trash |
|
|
The site is locked for deletion |
|
|
Data type error in the 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 Site landing.site.add
- Update Site landing.site.update
- Get the List of Sites landing.site.getList
- Mark the site as deleted landing.site.markDelete
- Restore Site from Recycle Bin landing.site.markUnDelete