Create a New Flow tasks.flow.Flow.create

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: task

Who can execute the method: any user who is not an extranet user

The method tasks.flow.Flow.create creates a flow.

The flow must be associated with a group. If the group ID is not provided when creating the flow, a new group will be automatically created, consisting of the creator, administrator, and flow team.

Method Parameters

Required parameters are marked with *

Name
type

Description

flowData*
object

Field values for creating the flow (detailed description below)

Parameter flowData

Required parameters are marked with *

Name
type

Description

name*
string

The name of the flow. Must be unique for each flow.

You can check the name using the method tasks.flow.Flow.isExists

description
string

Description of the flow

groupId
integer

The ID of the group to which the flow will be linked.

If not specified, a new group will be automatically created

ownerId
integer

The ID of the flow administrator.

If not specified, the creator will be the flow administrator

templateId
integer

The ID of the template that users will use to add tasks to the flow

plannedCompletionTime*
integer

The planned time to complete the task in seconds

distributionType*
string

Type of distribution:

  • manually — manual distribution
  • queue — distribution by queue
  • himself — self-distribution

More about distribution types can be found in the article Flows: Overview of Methods

responsibleList*
object

IDs of employees who will receive tasks.

For manual distribution, specify the moderator's ID.

For self-distribution or queue distribution, specify the IDs of employees or departments. For example:

[
            [
                'department','3'
            ],
            [
                'department','17:F'
            ]
        ]
        

If you do not add the suffix :F, the system will select all sub-departments of the specified department according to the company structure

taskCreators
object

List of users who can add tasks to the flow in the {"<entity-type>": "<entity-id>"} format. For example

[
            [
                'user','3'
            ],
            [
                'department','17:F'
            ]
        ]
        

If you do not add the :F suffix, the system will select all sub-departments of the specified department according to the company structure

To allow all users to add tasks, specify the value {"meta-user": "all-users"}

matchWorkTime
integer

Skip weekends and holidays when calculating the task deadline.

Accepts values 0 and 1. Default is 1

responsibleCanChangeDeadline
integer

Can the responsible person change the task deadline.

Accepts values 0 and 1. Default is 0

notifyAtHalfTime
integer

Notify the performer at half the task deadline.

Accepts values 0 and 1. Default is 0

taskControl
integer

Send the completed task to the creator for review.

Accepts values 0 and 1. Default is 0

notifyOnQueueOverflow
integer

Notify the flow administrator when the number of tasks in the queue exceeds this parameter.

Default is null, meaning no notifications

notifyOnTasksInProgressOverflow
integer

Notify the flow administrator when the number of tasks in progress exceeds this parameter.

Default is null, meaning no notifications

notifyWhenEfficiencyDecreases
integer

Notify the flow administrator when efficiency drops below this parameter.

Default is null, meaning no notifications

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
            "flowData": {
                "name": "Unique Flow Name",
                "description": "Flow description",
                "plannedCompletionTime": 7200,
                "distributionType": "manually",
                "responsibleList": [["user","3"]],
                "taskCreators": [["meta-user","all-users"]],
                "matchWorkTime": 1,
                "notifyAtHalfTime": 0
            }
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.flow.Flow.create
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
        -d '{
            "flowData": {
                "name": "Unique Flow Name",
                "description": "Flow description",
                "plannedCompletionTime": 7200,
                "distributionType": "manually",
                "responsibleList": [["user","3"]],
                "taskCreators": [["meta-user","all-users"]],
                "matchWorkTime": 1,
                "notifyAtHalfTime": 0
            }
        }' \
        https://your-domain.bitrix24.com/rest/tasks.flow.Flow.create
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type FlowCreateResult = {
          id: number
          creatorId: number
          ownerId: number
          groupId: number
          templateId: number
          efficiency: number
          active: boolean
          plannedCompletionTime: number
          activity: ISODate
          name: string
          description: string
          distributionType: string
          responsibleList: string[][]
          demo: boolean
          responsibleCanChangeDeadline: boolean
          matchWorkTime: boolean
          taskControl: boolean
          notifyAtHalfTime: boolean
          notifyOnQueueOverflow: number | null
          notifyOnTasksInProgressOverflow: number | null
          notifyWhenEfficiencyDecreases: number | null
          taskCreators: string[][]
          team: string[][]
          trialFeatureEnabled: boolean
        }
        
        try {
          const response = await $b24.actions.v2.call.make<FlowCreateResult>({
            method: 'tasks.flow.Flow.create',
            params: {
              flowData: {
                name: 'Unique Flow Name',
                description: 'Flow description',
                plannedCompletionTime: 7200,
                distributionType: 'manually',
                responsibleList: [['user', '3']],
                taskCreators: [['meta-user', 'all-users']],
                matchWorkTime: 1,
                notifyAtHalfTime: 0,
              },
            },
            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('Created flow:', result.id, result.name, result.active)
          }
        } 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 createFlow() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'tasks.flow.Flow.create',
                params: {
                  flowData: {
                    name: 'Unique Flow Name',
                    description: 'Flow description',
                    plannedCompletionTime: 7200,
                    distributionType: 'manually',
                    responsibleList: [['user', '3']],
                    taskCreators: [['meta-user', 'all-users']],
                    matchWorkTime: 1,
                    notifyAtHalfTime: 0,
                  },
                },
                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('Created flow:', result.id, result.name, result.active)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', createFlow)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        flow_data = {
            "name": "Unique Flow Name",
            "description": "Flow description",
            "plannedCompletionTime": 7200,
            "distributionType": "manually",
            "responsibleList": [
                [
                    "user",
                    "3",
                ],
            ],
            "taskCreators": [
                [
                    "meta-user",
                    "all-users",
                ],
            ],
            "matchWorkTime": 1,
            "notifyAtHalfTime": 0,
        }
        
        try:
            bitrix_response = client.tasks.flow.flow.create(
                flow_data=flow_data,
            ).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.flow.Flow.create',
                    [
                        'flowData' => [
                            'name'                  => 'Unique Flow Name',
                            'description'           => 'Flow description',
                            'plannedCompletionTime' => 7200,
                            'distributionType'      => 'manually',
                            'responsibleList'       => [
                                ['user', '3']
                            ],
                            'taskCreators'          => [
                                ['meta-user', 'all-users']
                            ],
                            'matchWorkTime'         => 1,
                            'notifyAtHalfTime'      => 0
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error creating flow: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'tasks.flow.Flow.create',
            {
                flowData: {
                    name: 'Unique Flow Name',
                    description: 'Flow description',
                    plannedCompletionTime: 7200,
                    distributionType: 'manually',
                    responsibleList: [
                        [
                            'user','3'
                        ]
                    ],
                    taskCreators: [
                        [
                            'meta-user','all-users'
                        ]
                    ],
                    matchWorkTime: 1,
                    notifyAtHalfTime: 0
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php'); // connecting CRest PHP SDK
        
        $flowData = [
            "name" => "Unique Flow Name",
            "description" => "Flow description",
            "plannedCompletionTime" => 7200,
            "distributionType" => "manually",
            "responsibleList" => [["user", "3"]],
            "taskCreators" => [["meta-user", "all-users"]],
            "matchWorkTime" => 1,
            "notifyAtHalfTime" => 0
        ];
        
        // executing a request to the REST API
        $result = CRest::call(
            'tasks.flow.Flow.create',
            [
                'flowData' => $flowData
            ]
        );
        
        // Processing the response from Bitrix24
        if ($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.flow.Flow.create", b24.Params{
        	"flowData": b24.Params{
        		"name":                  "Unique Flow Name",
        		"description":           "Flow description",
        		"plannedCompletionTime": 7200,
        		"distributionType":      "manually",
        		"responsibleList": []any{
        			[]string{"user", "3"},
        		},
        		"taskCreators": []any{
        			[]string{"meta-user", "all-users"},
        		},
        		"matchWorkTime":    1,
        		"notifyAtHalfTime": 0,
        	},
        })
        if err != nil {
        	return fmt.Errorf("tasks.flow.Flow.create: %w", err)
        }
        
        var item struct {
        	ID         b24.ID `json:"id"`
        	CreatorID  b24.ID `json:"creatorId"`
        	OwnerID    b24.ID `json:"ownerId"`
        	GroupID    b24.ID `json:"groupId"`
        	TemplateID b24.ID `json:"templateId"`
        	Efficiency int    `json:"efficiency"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.CreatorID)
        

Response Handling

HTTP status: 200

{
            "result": {
                "id": 517,
                "creatorId": 1,
                "ownerId": 1,
                "groupId": 178,
                "templateId": 0,
                "efficiency": 0,
                "active": true,
                "plannedCompletionTime": 7200,
                "activity": "2024-09-02T15:27:29+00:00",
                "name": "Updated Flow Name",
                "description": "Updated description",
                "distributionType": "manually",
                "responsibleList": [
                    [
                        "user",
                        "3"
                    ]
                ],
                "demo": false,
                "responsibleCanChangeDeadline": true,
                "matchWorkTime": true,
                "taskControl": false,
                "notifyAtHalfTime": false,
                "notifyOnQueueOverflow": 10,
                "notifyOnTasksInProgressOverflow": 50,
                "notifyWhenEfficiencyDecreases": null,
                "taskCreators": [
                    [
                        "meta-user",
                        "all-users"
                    ]
                ],
                "team": [
                    [
                        "user",
                        "3"
                    ]
                ],
                "trialFeatureEnabled": false
            }
        }
        

Returned Data

Name
type

Description

result
object

Object containing flow data

id
integer

ID of the created flow

creatorId
integer

ID of the flow creator. Read-only

ownerId
integer

ID of the flow administrator

groupId
integer

ID of the group to which the flow is linked

templateId
integer

ID of the template used to create tasks in the flow

efficiency
integer

Efficiency of the flow in percentage. Read-only

active
boolean

Status of the flow's activity

plannedCompletionTime
integer

The planned time to complete the task in seconds

activity
string

Date and time of the last activity in the flow. Read-only

name
string

Flow name

description
string

Description of the flow

distributionType
string

Type of task distribution in the flow

responsibleList
array

List of responsible persons for tasks in the flow. For manual distribution, this is the flow moderator

demo
boolean

Indicates whether the flow is a demo. System parameter. Read-only

responsibleCanChangeDeadline
boolean

Can the responsible person change the task deadline

matchWorkTime
boolean

Whether to skip weekends and holidays when calculating the task deadline

taskControl
boolean

Whether to send the completed task to the creator for review

notifyAtHalfTime
boolean

Whether to notify the performer at half the task deadline

notifyOnQueueOverflow
integer

Number of tasks in the queue, exceeding which will send a notification to the flow administrator (if null, notifications are disabled)

notifyOnTasksInProgressOverflow
integer

Number of tasks in progress, exceeding which will send a notification to the flow administrator (if null, notifications are disabled)

notifyWhenEfficiencyDecreases
integer

Efficiency in percentage, below which a notification will be sent to the flow administrator (if null, notifications are disabled)

taskCreators
object

List of users who can add tasks to the flow in the {"<object-type>": "<object-id>"} format. For example, [{"user": 3}, {"department": "17:F"}].

Item {"meta-user": "all-users"} means that all users can add tasks

team
object

Flow team.

For manual distribution, this includes all project participants linked to the flow, except for the moderator.

For queue and self-distribution, the team is the same as in responsibleList

trialFeatureEnabled
boolean

Indicates whether the trial period is enabled for the flow. System parameter. Read-only

Error Handling

HTTP status: 400

{
            "error": "0",
            "error_description": "Access denied or flow 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

Additional Information

0

Access denied or flow not found

The portal's plan does not allow working with flows or the user does not have permission to create a flow

0

Unknown error

Unknown error

0

'distributionType': field's value has an invalid value

Invalid value for distributionType (similarly for other parameters)

0

A flow with this name already exists

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

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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