Add Epic in Scrum tasks.api.scrum.epic.add

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: task

Who can execute the method: any user with access to Scrum

This method adds an epic to Scrum.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Field values (detailed description provided below) for adding a new epic in the form of a structure:

fields: {
            name: 'value',
            groupId: 'value',
            description: 'value',
            color: 'value',
            files: [
                'file1',
                'file2',
                ...
            ]
        
        }
        

Parameter fields

Required parameters are marked with *

Name
type

Description

name*
string

Epic name

description
string

Epic description

groupId*
integer

Identifier of the group (scrum) to which the epic belongs

color
string

Epic color

files
array

Array of files associated with the epic.

In files, you can pass an array of values with file identifiers, specifying the prefix n for each identifier

createdBy
integer

Created by

modifiedBy
integer

Modified by

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "fields": {
            "name": "Epic 1",
            "groupId": 1,
            "description": "Description text",
            "color": "#69dafc",
            "files": ["n428", "n345"]
        }
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "fields": {
            "name": "Epic 1",
            "groupId": 1,
            "description": "Description text",
            "color": "#69dafc",
            "files": ["n428", "n345"]
        }
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.add
        
// 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 EpicAddResult = {
          id: number
          groupId: number
          name: string
          description: string
          createdBy: number
          modifiedBy: number
          color: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<EpicAddResult>({
            method: 'tasks.api.scrum.epic.add',
            params: {
              fields: {
                name: 'Epic 1',
                groupId: 1,
                description: 'Description text',
                color: '#69dafc',
                files: ['n428', 'n345'],
              },
            },
            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('Added epic:', result.id, result.name)
          }
        } 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 addEpic() {
            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.add',
                params: {
                  fields: {
                    name: 'Epic 1',
                    groupId: 1,
                    description: 'Description text',
                    color: '#69dafc',
                    files: ['n428', 'n345'],
                  },
                },
                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('Added epic:', result.id, result.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addEpic)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.tasks.api.scrum.epic.add(
                fields={
                    "name": "Epic 1",
                    "groupId": 1,
                    "description": "Description text",
                    "color": "#69dafc",
                    "files": [
                        "n428",
                        "n345",
                    ],
                },
            ).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 {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.epic.add',
                    [
                        'fields' => [
                            'name'        => $name,
                            'groupId'     => $groupId,
                            'description' => $description,
                            'color'       => $color,
                            'files'       => $files,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding epic: ' . $e->getMessage();
        }
        
const groupId = 1;
        const name = 'Epic 1';
        const description = 'Description text';
        const color = '#69dafc';
        const files = ['n428', 'n345'];
        
        BX24.callMethod(
            'tasks.api.scrum.epic.add',
            {
                fields: {
                    name: name,
                    groupId: groupId,
                    description: description,
                    color: color,
                    files: files
                }
            },
            function(res)
            {
                console.log(res);
            }
        );
        
require_once('crest.php'); // include CRest PHP SDK
        
        $groupId = 1;
        $name = 'Epic 1';
        $description = 'Description text';
        $color = '#69dafc';
        $files = ['n428', 'n345'];
        
        // execute request to REST API
        $result = CRest::call(
            'tasks.api.scrum.epic.add',
            [
                'fields' => [
                    'name' => $name,
                    'groupId' => $groupId,
                    'description' => $description,
                    'color' => $color,
                    'files' => $files
                ]
            }
        );
        
        // Process response from Bitrix24
        if (isset($result['error'])) {
            echo 'Error: '.$result['error_description'];
        }
        else {
            print_r($result['result']);
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "tasks.api.scrum.epic.add", b24.Params{
        	"fields": b24.Params{
        		"name":        "Epic 1",
        		"groupId":     1,
        		"description": "Description text",
        		"color":       "#69dafc",
        		"files":       []string{"n428", "n345"},
        	},
        })
        if err != nil {
        	return fmt.Errorf("tasks.api.scrum.epic.add: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP Status: 200

{
            "id": 4,
            "groupId": 1,
            "name": "Epic 1",
            "description": "Description text",
            "createdBy": 1,
            "modifiedBy": 1,
            "color": "#69dafc"
        }
        

Returned Data

Name
type

Description

id
integer

Epic identifier

groupId
integer

Identifier of the group (scrum) to which the epic is linked

name
string

Epic name

description
string

Epic description

createdBy
integer

Identifier of the user who created the epic

modifiedBy
integer

Identifier of the user who last modified the epic

color
string

Epic color in HEX format

Error Handling

HTTP Status: 400

{
            "error": 0,
            "error_description": "Group is not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

0

Access denied

No access to scrum

0

Epic not created

Failed to create epic

0

createdBy user not found

User in the "creator" field not found

0

modifiedBy user not found

User in the "last modified by" field not found

0

Group is not found

GROUP_ID parameter not specified or group with such ID does not exist

0

Name is not found

NAME parameter not specified

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning