Add Task to Scrum Kanban tasks.api.scrum.kanban.addTask

Scope: task

Who can execute the method: any user

This method adds a task to the Scrum kanban.

Method Parameters

Required parameters are marked with *

Name `type`	Description
sprintId* `integer`	Identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list
taskId* `integer`	Identifier of the task. You can obtain the identifier using the method tasks.task.list
stageId* `integer`	Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages

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" \
        -H "Accept: application/json" \
        -d '{"sprintId":5,"taskId":751,"stageId":58}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.addTask

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"sprintId":5,"taskId":751,"stageId":58,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.addTask

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.kanban.addTask',
        		{
        			"sprintId": 5,
        			"taskId": 751,
        			"stageId": 58,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.kanban.addTask',
                    [
                        'sprintId' => 5,
                        'taskId'   => 751,
                        'stageId'  => 58,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding task: ' . $e->getMessage();
        }

BX24.callMethod(
            'tasks.api.scrum.kanban.addTask',
            {
                "sprintId": 5,
                "taskId": 751,
                "stageId": 58,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.api.scrum.kanban.addTask',
            [
                'sprintId' => 5,
                'taskId' => 751,
                'stageId' => 58
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1712137817.343984,
                "finish": 1712137817.605804,
                "duration": 0.26182007789611816,
                "processing": 0.018325090408325195,
                "date_start": "2024-04-03T12:50:17+02:00",
                "date_finish": "2024-04-03T12:50:17+02:00"
            }
        }

Error Handling

HTTP status: 400

{
            "error": 0,
            "error_description": "TaskId id 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`	`Sprint id not found`	Required field `sprintId` is not filled
`0`	`TaskId id not found`	Required field `taskId` is not filled
`0`	`StageId id not found`	Required field `stageId` is not filled
`0`	`Sprint not found`	An unknown sprint identifier was provided
`0`	`Stage not found`	An unknown stage identifier was provided
`0`	`Task not found. The task must be with GROUP_ID`	An unknown task identifier was provided or the task does not belong to the sprint group
`0`	`Access denied`	Access is denied
`0`	Unknown error

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

Delete a stage

Remove a task from Kanban

Add Task to Scrum Kanban tasks.api.scrum.kanban.addTask

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning