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

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

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

Scope: task

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

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

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

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

Название
тип

Описание

id*
integer

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

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

fields*
array

Значения полей (подробное описание приведено ниже) для добавления нового эпика в виде структуры:

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

Параметр fields

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

Название `тип`	Описание
name* `string`	Название эпика
description `string`	Описание эпика
groupId* `integer`	Идентификатор группы (скрама), к которой относится эпик
color `string`	Цвет эпика
files `array`	Массив файлов, привязанных к эпику. В `files` можно передать массив значений с идентификаторами файлов, указав префикс `n` для каждого идентификатора. Внимание Если передать пустой массив — файлы удалятся

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "fields": {
            "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 '{
        "fields": {
            "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

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.epic.update',
        		{
        			id: epicId,
        			fields:{
        				name: name,
        				description: description,
        				color: color,
        				files: files
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('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'); // подключение 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

{
            "id": 1,
            "groupId": 143,
            "name": "Updated epic name",
            "description": "Updated description text",
            "createdBy": 1,
            "modifiedBy": 1,
            "color": "#bbecf1"
        }

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

Название `тип`	Описание
id `integer`	Идентификатор эпика
groupId `integer`	Идентификатор группы (скрама), к которой привязан эпик
name `string`	Название эпика
description `string`	Описание эпика
createdBy `integer`	Идентификатор пользователя, создавшего эпик
modifiedBy `integer`	Идентификатор пользователя, который последним изменял эпик
color `string`	Цвет эпика

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

HTTP-статус: 400

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`0`	Access denied	Нет доступа для просмотра данных эпика
`0`	Epic not found	Такого эпика не существует
`0`	Epic not updated	Не удалось обновить эпик
`0`	createdBy user not found	Пользователь в поле «создатель» не найден
`0`	modifiedBy user not found	Пользователь в поле «последний изменивший» не найден
`100`	Could not find value for parameter	Неверно указано имя параметра или не задан параметр
`100`	Invalid value {stringValue} to match with parameter {id}. Should be value of type int.	Неверный тип параметра

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить эпик в Скрам

Получить поля эпика по его идентификатору

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

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

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

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

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

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

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