Delete Epic tasks.api.scrum.epic.delete
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:
taskWho can execute the method: any user with access to Scrum
This method deletes an epic.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the epic. You can obtain epic identifiers using the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 1
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN" \
-d '{
"id": 1
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.delete
try
{
const response = await $b24.callMethod(
'tasks.api.scrum.epic.delete',
{
id: epicId,
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$epicId = 1;
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.delete',
[
'id' => $epicId,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting epic: ' . $e->getMessage();
}
const epicId = 1;
BX24.callMethod(
'tasks.api.scrum.epic.delete',
{
id: epicId,
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // connecting CRest PHP SDK
// executing request to REST API
$result = CRest::call(
'tasks.api.scrum.epic.delete',
[
'id' => 1,
]
);
// Processing the response from Bitrix24
if (isset($result['error'])) {
echo 'Error: '.$result['error_description'];
}
else {
print_r($result['result']);
}
Response Handling
Upon successful deletion, the method returns an empty array.
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "Epic not found"
}
|
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 |
Value |
|
|
Access denied |
No access to Scrum |
|
|
Epic not found |
The epic does not exist |
|
|
Could not find value for parameter |
Incorrect parameter name or parameter not set |
|
|
Invalid value {stringValue} to match with parameter {id}. Should be value of type int. |
Invalid parameter type |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
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
- Epics in Scrum: Overview of Methods
- Add Epic in Scrum tasks.api.scrum.epic.add
- Update Epic in Scrum tasks.api.scrum.epic.update
- Get Epic Fields by Its Identifier tasks.api.scrum.epic.get
- Get a List of Epics tasks.api.scrum.epic.list
- Get a list of available fields for epic tasks.api.scrum.epic.getFields