Update Epic in Scrum tasks.api.scrum.epic.update
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
taskWho can execute the method: any user with access to Scrum
This method updates an epic in Scrum.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Epic identifier. You can obtain epic identifiers using the |
|
fields* |
Epic fields to change (Detailed Description), in the form of a structure:
|
Parameter fields
Pass only the fields you need to change. The method leaves the other epic fields unchanged.
|
Name |
Description |
|
name |
Epic name, up to 255 characters. The method does not retain an empty string |
|
description |
Epic description |
|
groupId |
Identifier of the Scrum to move the epic to. Requires access to the tasks of both groups |
|
color |
Epic color, for example |
|
files |
Array of Drive file identifiers with the New files are added to those already attached. Attention If you pass an empty array, the method detaches all files from the epic. The method skips an identifier without the |
|
createdBy |
Identifier of the user to be set as the creator of the epic |
|
modifiedBy |
Identifier of the user to be set as the last modifier of the epic. Defaults to the current user |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 1,
"fields": {
"name": "Updated epic name",
"description": "Updated description text",
"color": "#bbecf1",
"files": ["n429", "n243"]
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.update
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 1,
"fields": {
"name": "Updated epic name",
"description": "Updated description text",
"color": "#bbecf1",
"files": ["n429", "n243"]
},
"auth": "YOUR_ACCESS_TOKEN"
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type EpicUpdateResult = {
id: number
groupId: number
name: string
description: string
createdBy: number
modifiedBy: number
color: string
}
try {
const response = await $b24.actions.v2.call.make<EpicUpdateResult>({
method: 'tasks.api.scrum.epic.update',
params: {
id: 1,
fields: {
name: 'Updated epic name',
description: 'Updated description text',
color: '#bbecf1',
files: ['n429', 'n243'],
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Updated epic:', result.id, result.name, result.color)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateEpic() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.api.scrum.epic.update',
params: {
id: 1,
fields: {
name: 'Updated epic name',
description: 'Updated description text',
color: '#bbecf1',
files: ['n429', 'n243'],
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Updated epic:', result.id, result.name, result.color)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateEpic)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.epic.update(
bitrix_id=1,
fields={
"name": "Updated epic name",
"description": "Updated description text",
"color": "#bbecf1",
"files": [
"n429",
"n243",
],
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$epicId = 1;
$name = 'Updated epic name';
$description = 'Updated description text';
$color = '#bbecf1';
$files = ['n429', 'n243'];
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.update',
[
'id' => $epicId,
'fields' => [
'name' => $name,
'description' => $description,
'color' => $color,
'files' => $files
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating epic: ' . $e->getMessage();
}
const epicId = 1;
const name = 'Updated epic name';
const description = 'Updated description text';
const color = '#bbecf1';
const files = ['n429', 'n243'];
BX24.callMethod(
'tasks.api.scrum.epic.update',
{
id: epicId,
fields:{
name: name,
description: description,
color: color,
files: files
}
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // connecting CRest PHP SDK
$epicId = 1;
$name = 'Updated epic name';
$description = 'Updated description text';
$color = '#bbecf1';
$files = ['n429', 'n243'];
// executing request to REST API
$result = CRest::call(
'tasks.api.scrum.epic.update',
[
'id' => $epicId,
'fields' => [
'name' => $name,
'description' => $description,
'color' => $color,
'files' => $files
]
]
);
// Processing the response from Bitrix24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
}
else {
print_r($result['result']);
}
Response Handling
HTTP Status: 200
{
"result": {
"id": 1,
"groupId": 143,
"name": "Updated epic name",
"description": "Updated description text",
"createdBy": 1,
"modifiedBy": 1,
"color": "#bbecf1"
},
"time": {
"start": 1790263154,
"finish": 1790263154.532794,
"duration": 0.5327939987182617,
"processing": 0,
"date_start": "2026-09-24T18:19:14+03:00",
"date_finish": "2026-09-24T18:19:14+03:00",
"operating_reset_at": 1790263754,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Epic data after the update (Detailed Description) |
|
time |
Information about the request execution time |
result Object
|
Name |
Description |
|
id |
Epic identifier |
|
groupId |
Identifier of the Scrum to which the epic belongs |
|
name |
Epic name |
|
description |
Epic description |
|
createdBy |
Identifier of the user who created the epic |
|
modifiedBy |
Identifier of the user who last modified the epic |
|
color |
Epic color |
The method does not return attached files. You can retrieve them using the tasks.api.scrum.epic.get method.
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Epic not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Epic not found |
An epic with this |
|
|
|
Access denied |
The user has no access to the tasks of the epic's group or of the group from |
|
|
|
createdBy user not found |
The user from |
|
|
|
modifiedBy user not found |
The user from |
|
|
|
Epic not updated |
Failed to save the changes, for example, the name is longer than 255 characters or the color is longer than 18 characters |
|
|
|
Epic files not attached |
The changes were saved, but the files could not be attached |
|
|
|
Could not find value for parameter |
The |
|
|
|
Invalid value {stringValue} to match with parameter {id}. Should be value of type int. |
A non-numeric value was passed in |
|
|
|
Could not find value for parameter |
The |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |