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

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.epic.add',
        		{
        			fields: {
        				name: name,
        				groupId: groupId,
        				description: description,
        				color: color,
        				files: files
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('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']);
        }

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 may consist of digits, Latin letters, and underscores
error_description `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
`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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Update Epic in Scrum

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

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning