Update the Flow tasks.flow.Flow.update
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:
taskWho can execute the method: Creator or administrator of the flow
The method tasks.flow.Flow.update modifies the flow.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
flowData* |
Field values to modify the flow (detailed description below) |
Parameter flowData
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the flow to be modified. You can obtain the identifier using the method for creating a new flow tasks.flow.Flow.create or by retrieving a task tasks.task.get for a task from the flow |
|
name |
Name of the flow. Must be unique for each flow. To check the name, you can use the method tasks.flow.Flow.isExists |
|
description |
Description of the flow |
|
groupId |
Identifier of the group to which the flow will be linked. If not specified, a new group is automatically created |
|
ownerId |
Identifier of the flow administrator. If not specified, the creator of the flow will be the administrator |
|
templateId |
The ID of the template that users will use to add tasks to the flow |
|
plannedCompletionTime* |
The planned time to complete the task in seconds |
|
distributionType* |
Type of distribution:
More about distribution types can be found in the article Flows: Overview of Methods |
|
responsibleList* |
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:
If you do not add the suffix |
|
taskCreators |
List of users who can add tasks to the flow in the
If you do not add the To allow all users to add tasks, specify the value |
|
matchWorkTime |
Skip weekends and holidays when calculating the task deadline. Accepts values |
|
responsibleCanChangeDeadline |
Can the responsible person change the task deadline. Accepts values |
|
notifyAtHalfTime |
Notify the performer at half the task deadline. Accepts values |
|
taskControl |
Send the completed task to the Creator for review. Accepts values |
|
notifyOnQueueOverflow |
Notify the flow administrator when the number of tasks in the queue exceeds this parameter. Default is |
|
notifyOnTasksInProgressOverflow |
Notify the flow administrator when the number of tasks in progress exceeds this parameter. Default is |
|
notifyWhenEfficiencyDecreases |
Notify the flow administrator when efficiency falls below this parameter. Default is |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"flowData": {
"id": 517,
"name": "Updated Flow Name",
"description": "Updated 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.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
"flowData": {
"id": 517,
"name": "Updated Flow Name",
"description": "Updated 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.update
// 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 FlowUpdateResult = {
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
notifyWhenEfficiencyDecreases: number | null
taskCreators: string[][]
team: string[][]
trialFeatureEnabled: boolean
}
try {
const response = await $b24.actions.v2.call.make<FlowUpdateResult>({
method: 'tasks.flow.Flow.update',
params: {
flowData: {
id: 517,
name: 'Updated Flow Name',
description: 'Updated 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('Updated flow:', result.id, result.name, result.distributionType)
}
} 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 updateFlow() {
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.update',
params: {
flowData: {
id: 517,
name: 'Updated Flow Name',
description: 'Updated 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('Updated flow:', result.id, result.name, result.distributionType)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateFlow)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
flow_data = {
"id": 517,
"name": "Updated Flow Name",
"description": "Updated description",
"plannedCompletionTime": 7200,
"distributionType": "manually",
"responsibleList": [
[
"user",
"3",
],
],
"taskCreators": [
[
"meta-user",
"all-users",
],
],
"matchWorkTime": 1,
"notifyAtHalfTime": 0,
}
try:
bitrix_response = client.tasks.flow.flow.update(
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.update',
[
'flowData' => [
'id' => 517,
'name' => 'Updated Flow Name',
'description' => 'Updated 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 updating flow: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.flow.Flow.update',
{
flowData: {
id: 517,
name: 'Updated Flow Name',
description: 'Updated 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 the CRest PHP SDK
$flowData = [
"id" => 517,
"name" => "Updated Flow Name",
"description" => "Updated 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.update',
[
'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.update", b24.Params{
"flowData": b24.Params{
"id": 517,
"name": "Updated Flow Name",
"description": "Updated 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.update: %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 |
Description |
|
result |
Object containing flow data |
|
id |
ID of the created flow |
|
creatorId |
ID of the flow creator. Read-only |
|
ownerId |
ID of the flow administrator |
|
groupId |
ID of the group to which the flow is linked |
|
templateId |
ID of the template used to create tasks in the flow |
|
efficiency |
Efficiency of the flow in percentage. Read-only |
|
active |
Status of the flow's activity |
|
plannedCompletionTime |
The planned time to complete the task in seconds |
|
activity |
Date and time of the last activity in the flow. Read-only |
|
name |
Flow name |
|
description |
Description of the flow |
|
distributionType |
Type of task distribution in the flow |
|
responsibleList |
List of responsible persons for tasks in the flow. For manual distribution, this is the flow moderator |
|
demo |
Indicates whether the flow is a demo. System parameter. Read-only |
|
responsibleCanChangeDeadline |
Can the responsible person change the task deadline |
|
matchWorkTime |
Whether to skip weekends and holidays when calculating the task deadline |
|
taskControl |
Whether to send the completed task to the creator for review |
|
notifyAtHalfTime |
Whether to notify the performer at half the task deadline |
|
notifyOnQueueOverflow |
Number of tasks in the queue, exceeding which will send a notification to the flow administrator (if |
|
notifyOnTasksInProgressOverflow |
Number of tasks in progress, exceeding which will send a notification to the flow administrator (if |
|
notifyWhenEfficiencyDecreases |
Efficiency in percentage, below which a notification will be sent to the flow administrator (if |
|
taskCreators |
List of users who can add tasks to the flow in the Item |
|
team |
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 |
|
trialFeatureEnabled |
Indicates whether the trial period is enabled for the flow. System parameter. Read-only |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Flow not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Additional Information |
|
|
Access denied or flow not found |
The portal plan does not allow working with flows or the user does not have permission to modify the flow |
|
|
|
Unknown error |
|
|
|
Invalid value for |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |