Обновить эпик в Скраме tasks.api.scrum.epic.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь, имеющий доступ к Скраму

Метод обновляет эпик в Скраме.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор эпика.

Получить идентификаторы эпиков можно методом tasks.api.scrum.epic.list

fields*
object

Поля эпика, которые нужно изменить (подробное описание), в виде структуры:

fields: {
    name: 'значение',
    groupId: 'значение',
    description: 'значение',
    color: 'значение',
    files: [
        'файл1',
        'файл2',
        ...
    ]

}

Параметр fields

Передайте только те поля, которые нужно изменить. Остальные поля эпика метод оставит без изменений.

Название
тип

Описание

name
string

Название эпика, до 255 символов. Пустую строку метод не сохраняет

description
string

Описание эпика

groupId
integer

Идентификатор Скрама, в который нужно перенести эпик. Нужен доступ к задачам обеих групп

color
string

Цвет эпика, например #bbecf1, до 18 символов

files
array

Массив идентификаторов файлов Диска с префиксом n, например ["n429"].

Новые файлы добавляются к уже прикрепленным.

Внимание

Если передать пустой массив, метод открепит от эпика все файлы. Идентификатор без префикса n метод пропускает без ошибки

createdBy
integer

Идентификатор пользователя, который будет указан создателем эпика

modifiedBy
integer

Идентификатор пользователя, который будет указан последним изменившим эпик. По умолчанию — текущий пользователь

Примеры кода

Как использовать примеры в документации

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",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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'); // подключение CRest PHP SDK
$epicId = 1;
$name = 'Updated epic name';
$description = 'Updated description text';
$color = '#bbecf1';
$files = ['n429', 'n243'];

// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.epic.update',
[
    'id' => $epicId,
    'fields' => [
        'name' => $name,
        'description' => $description,
        'color' => $color,
        'files' => $files
    ]
]
);

// Обработка ответа от Битрикс24
if ($result['error']) {
    echo 'Error: '.$result['error_description'];
}
else {
    print_r($result['result']);
}

Обработка ответа

HTTP-статус: 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
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Данные эпика после изменения (подробное описание)

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

id
integer

Идентификатор эпика

groupId
integer

Идентификатор Скрама, к которому относится эпик

name
string

Название эпика

description
string

Описание эпика

createdBy
integer

Идентификатор пользователя, создавшего эпик

modifiedBy
integer

Идентификатор пользователя, который последним изменил эпик

color
string

Цвет эпика

Прикрепленные файлы метод не возвращает. Получить их можно методом tasks.api.scrum.epic.get.

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Epic not found"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

0

Epic not found

Эпика с таким id не существует

400

0

Access denied

У пользователя нет доступа к задачам группы эпика или группы из groupId, либо такой группы не существует

400

0

createdBy user not found

Пользователя из createdBy не существует

400

0

modifiedBy user not found

Пользователя из modifiedBy не существует

400

0

Epic not updated

Не удалось сохранить изменения, например название длиннее 255 символов или цвет длиннее 18 символов

400

0

Epic files not attached

Изменения сохранены, но файлы прикрепить не удалось

400

100

Could not find value for parameter

Не передан параметр id

400

100

Invalid value {stringValue} to match with parameter {id}. Should be value of type int.

В id передано не число

400

100

Could not find value for parameter

Не передан параметр fields

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение