Обновить действие bizproc.activity.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: bizproc

Кто может выполнять метод: администратор

Метод bizproc.activity.update обновляет действие бизнес-процессов, добавленное приложением.

Работает только в контексте приложения.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

CODE*
string

Внутренний идентификатор действия

FIELDS*
object

Объект с полями действия бизнес-процесса

Параметр FIELDS

Передайте в FIELDS хотя бы одно поле для обновления.

Название
тип

Описание

HANDLER
string

URL, на который действие будет отправлять данные через сервер очередей bitrix24.

В ссылке должен быть тот же домен, на котором установлено приложение

AUTH_USER_ID
integer

Идентификатор пользователя, токен которого будет передан приложению

USE_SUBSCRIPTION
boolean

Должно ли действие ожидать ответа от приложения. Возможные значения:

  • Y — да
  • N — нет

NAME
string | object

Название действия.

Может быть строкой или ассоциативным массивом локализированных строк вида:

'NAME': {
    'ru': 'название действия',
    'en': 'action name',
    ...
},

DESCRIPTION
string | object

Описание действия.

Может быть строкой или ассоциативным массивом локализированных строк вида:

'DESCRIPTION': {
    'ru': 'описание действия',
    'en': 'action description',
    ...
},

PROPERTIES
object

Объект с параметрами действия. Содержит объекты, каждый из которых описывает параметр действия.

Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _

RETURN_PROPERTIES
object

Объект с дополнительными результатами действия. Содержит объекты, каждый из которых описывает параметр действия.

Параметр управляет возможностью действия ожидать ответа приложения и работать с данными, которые придут в ответе.

Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _

DOCUMENT_TYPE
array

Тип документа, который будет определять типы данных для параметров PROPERTIES и RETURN_PROPERTIES. Состоит из трех элементов типа строка:

  • идентификатор модуля
  • идентификатор объекта
  • тип документа

Возможные варианты значений:

  • Модуль CRM
    ['crm', 'CCrmDocumentLead', 'LEAD'] — лиды
    ['crm', 'CCrmDocumentContact', 'CONTACT'] — контакты
    ['crm', 'CCrmDocumentCompany', 'COMPANY'] — компании
    ['crm', 'CCrmDocumentDeal', 'DEAL'] — сделки
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE'] — коммерческие предложения
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE'] — счета
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_XXX'] — смарт-процессы, где XXX — идентификатор смарт-процесса

  • Модуль Списки
    ['lists', 'BizprocDocument', 'iblock_XXX'] — процессы в ленте новостей, где XXX — идентификатор информационного блока
    ['lists', 'Bitrix\Lists\BizprocDocumentLists', 'iblock_XXX'] — списки в группах, где XXX — идентификатор информационного блока

  • Модуль Диск
    ['disk', 'Bitrix\Disk\BizProcDocument', 'STORAGE_XXX'], где XXX — идентификатор хранилища

FILTER
object

Объект с правилами ограничения действия по типу документа и редакции.

Может содержать ключи:

  • INCLUDE — массив правил, где действие будет отображено
  • EXCLUDE — массив правил, где действие будет скрыто

Каждое правило в массиве может быть строкой или массивом типа документа в полном или частичном варианте.

Чтобы ограничить действие по редакции Битрикс24 укажите:

  • b24 — для облака
  • box — для коробки

Примеры:

  1. Исключить действие для коробочного Битрикс24 
    FILTER: {
    EXCLUDE: [ 'box' ]
}
  2. Отображать действие только для модуля Списки 
    FILTER: {
    INCLUDE: [
        ['lists']
    ]
}
  3. Отображать действие только для модуля Списки и сделок из CRM 
    FILTER: {
    INCLUDE: [
        ['lists'],
        ['crm', 'CCrmDocumentDeal']
    ]
}

USE_PLACEMENT
boolean

Дает возможность открывать дополнительные настройки действия в слайдере приложения. Возможные значения:

  • Y — да
  • N — нет

PLACEMENT_HANDLER
string

URL обработчика встройки на стороне приложения

Объект PROPERTY

Название
тип

Описание

Name
string | object

Наименование параметра

Description
string | object

Описание параметра

Type
string

Тип параметра. Базовые значения:

  • bool — да или нет
  • date — дата
  • datetime — дата и время
  • double — число
  • file — файл
  • int — целое число
  • select — список
  • string — строка
  • text — текст
  • user — пользователь

Options
array

Массив значений параметра типа список 'TYPE': select' вида:

[
    'value1': 'title1',
    'value2': 'title2',
    'value3': 'title3',
    'value4': 'title4'
]

Required
boolean

Обязательность параметра. Возможные значения:

  • Y — да
  • N — нет

Multiple
boolean

Множественность параметра. Возможные значения:

  • Y — да
  • N — нет

Default
any

Значение параметра по умолчанию

Примеры объектов

Ниже приведены примеры объектов PROPERTY для разных типов параметров.

  • select

    'docType': {
    'Name': {
        'ru': 'Тип документа',
        'en': 'Document type'
    },
    'Required': 'Y',
    'Multiple': 'N',
    'Default': 'PDF',
    'Type': 'select',
    'Options': {
        'pdf': 'PDF',
        'docx': 'DOCX'
    }
}

  • bool

    'saveDoc': {
    'Name': {
        'ru': 'Сохранить документ',
        'en': 'Save document'
    },
    'Description': {
        'ru': 'Присвоить порядковый номер',
        'en': 'Assign a sequential number'
    },
    'Type': 'bool',
    'Required': 'Y',
    'Multiple': 'N',
    'Default': 'Y'
}

  • file

    'attachment': {
    'Name': {
        'ru': 'Файл',
        'en': 'File'
    },
    'Description': {
        'ru': 'Файл для отправки',
        'en': 'File to send'
    },
    'Type': 'file',
    'Required': 'N',
    'Multiple': 'Y'
}

  • string

    'Parameters': {
    'Name': {
        'ru': 'Параметры шаблона',
        'en': 'Template\'s parameters'
    },
    'Description': {
        'ru': 'ParamID={=ParamValue}',
        'en': 'ParamID={=ParamValue}'
    },
    'Type': 'string',
    'Required': 'N',
    'Multiple': 'Y'
}

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"action_test_code","FIELDS":{"AUTH_USER_ID":1,"USE_SUBSCRIPTION":"N","FILTER":{"INCLUDE":[["lists"],["crm","CCrmDocumentDeal"]]}}, "auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.activity.update

try
{
	const response = await $b24.callMethod(
		'bizproc.activity.update',
		{
			'CODE': 'action_test_code',
			'FIELDS': {
				'AUTH_USER_ID': 1,
				'USE_SUBSCRIPTION': 'N',
				'FILTER': {
					'INCLUDE': [
						['lists'],
						['crm', 'CCrmDocumentDeal']
					]
				}
			},
		}
	);
	
	const result = response.getData().result;
	alert("Успешно: " + result);
}
catch( error )
{
	alert("Error: " + error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.activity.update(
        code="action_test_code",
        fields={
            "AUTH_USER_ID": 1,
            "USE_SUBSCRIPTION": "N",
            "FILTER": {
                "INCLUDE": [
                    [
                        "lists",
                    ],
                    [
                        "crm",
                        "CCrmDocumentDeal",
                    ],
                ],
            },
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $result = $serviceBuilder
        ->getBizProcScope()
        ->activity()
        ->update(
            'activity_code',
            'https://example.com/handler',
            1,
            ['en' => 'Activity Name', 'ru' => 'Название Активности'],
            ['en' => 'Activity Description', 'ru' => 'Описание Активности'],
            true,
            ['param1' => 'value1'],
            false,
            ['returnParam1' => 'value1'],
            null,
            null
        );

    if ($result->isSuccess()) {
        print($result->getCoreResponse()->getResponseData()->getResult()[0]);
    } else {
        print('Update failed.');
    }
} catch (Throwable $e) {
    print('Error: ' . $e->getMessage());
}

BX24.callMethod(
    'bizproc.activity.update',
    {
        'CODE': 'action_test_code',
        'FIELDS': {
            'AUTH_USER_ID': 1,
            'USE_SUBSCRIPTION': 'N',
            'FILTER': {
                'INCLUDE': [
                    ['lists'],
                    ['crm', 'CCrmDocumentDeal']
                ]
            }
        },
    },
    function(result)
    {
        if(result.error())
            alert("Error: " + result.error());
        else
            alert("Успешно: " + result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'bizproc.activity.update',
    [
        'CODE' => 'action_test_code',
        'FIELDS' => [
            'AUTH_USER_ID' => 1,
            'USE_SUBSCRIPTION' => 'N',
            'FILTER' => [
                'INCLUDE' => [
                    ['lists'],
                    ['crm', 'CCrmDocumentDeal']
                ]
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.activity.update", b24.Params{
	"CODE": "action_test_code",
	"FIELDS": b24.Params{
		"AUTH_USER_ID":     1,
		"USE_SUBSCRIPTION": "N",
		"FILTER": b24.Params{
			"INCLUDE": []any{
				[]string{"lists"},
				[]string{"crm", "CCrmDocumentDeal"},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("bizproc.activity.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

Обработка ответа

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1738149954.2918739,
        "finish": 1738149954.4590819,
        "duration": 0.16720795631408691,
        "processing": 0.017282962799072266,
        "date_start": "2025-01-29T14:25:54+03:00",
        "date_finish": "2025-01-29T14:25:54+03:00",
        "operating_reset_at": 1738150554,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
boolean

Возвращает true, если действие успешно обновлено

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_ACTIVITY_VALIDATION_FAILURE",
    "error_description": "Wrong properties array!"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Сообщение об ошибке

Описание

ACCESS_DENIED

Application context required

Необходим контекст приложения

ACCESS_DENIED

Access denied!

Метод выполнил не администратор

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty activity code!

Не указан код действия

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity code!

Некорректный код действия

ERROR_ACTIVITY_NOT_FOUND

Activity or Robot not found!

Действие или робот не найдены

ERROR_UNSUPPORTED_PROTOCOL

Unsupported handler protocol

Некорректный протокол хендлера http, https

ERROR_WRONG_HANDLER_URL

Wrong handler URL

Невалидный урл хендлера

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong properties array!

Некорректно заполнены параметры PROPERTIES или RETURN_PROPERTIES

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong property key <ключ>!

Некорректный идентификатор свойства

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty property NAME <ключ>!

Не указано название свойства

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity FILTER!

Некорректный фильтр

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity DOCUMENT_TYPE!

Некорректный DOCUMENT_TYPE

ERROR_ACTIVITY_VALIDATION_FAILURE

No fields to update

Нет полей для обновления

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Добавить новое действие
Следующая
Получить список действий приложения