# bizproc.robot.update

URL: https://chugunov.pro/api-bitrix24/bizproc/bizproc-robot/bizproc-robot-update/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Обновить поля робота
Scope: `bizproc`
Кто может выполнять метод: администратор

## Описание

Метод `bizproc.robot.update` обновляет поля робота, зарегистрированного приложением.

Работает только в контексте [приложения](https://apidocs.bitrix24.ru/settings/app-installation/index.html).

## Параметры

- `CODE` `string` — обязательный. Внутренний идентификатор робота
- `FIELDS` `object` — обязательный. Объект с [полями](#parametr-fields) робота

### Параметр FIELDS

- `HANDLER` `string` — необязательный. URL, на который робот будет отправлять данные через сервер очередей bitrix24.
  В ссылке должен быть тот же домен, на котором установлено приложение
- `AUTH_USER_ID` `integer` — необязательный. Идентификатор пользователя, токен которого будет передан приложению
- `USE_SUBSCRIPTION` `boolean` — необязательный. Должен ли робот ожидать ответа от приложения. Возможные значения:
  - `Y` — да
  - `N` — нет
- `NAME` `string` — необязательный. Название робота.
  Может быть строкой или ассоциативным массивом локализированных строк вида:
  ```js
  'NAME': {
      'ru': 'название робот',
      'en': 'robot name',
      ...
  },
  ```
- `DESCRIPTION` `string` — необязательный. Описание робота.
  Может быть строкой или ассоциативным массивом локализированных строк вида:
  ```js
  'DESCRIPTION': {
      'ru': 'описание робота',
      'en': 'robot description',
      ...
  },
  ```
- `PROPERTIES` `object` — необязательный. Объект с параметрами робота. Содержит объекты, каждый из которых описывает [параметр робота](#property).
  Системное название параметра должно начинаться с буквы и может содержать символы `a-z`, `A-Z`, `0-9` и нижнее подчеркивание `_`
- `RETURN_PROPERTIES` `object` — необязательный. Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает [параметр робота](#property).
  Параметр управляет возможностью робота ожидать ответа приложения и работать с данными, которые [придут в ответе](https://chugunov.pro/api-bitrix24/bizproc/bizproc-robot/bizproc-event-send/).
  Системное название параметра должно начинаться с буквы и может содержать символы `a-z`, `A-Z`, `0-9` и нижнее подчеркивание `_`
- `DOCUMENT_TYPE` `array` — необязательный. Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка: 
  - идентификатор модуля
  - идентификатор объекта
  - тип документа
  Возможные варианты значений:
  - Модуль CRM
      `['crm', 'CCrmDocumentLead', 'LEAD']` — лиды
      `['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 — идентификатор смарт-процесса
- `FILTER` `object` — необязательный. Объект с правилами ограничения робота по типу документа и редакции.
  Может содержать ключи:
  - `INCLUDE` — массив правил, где робот будет отображен
  - `EXCLUDE` — массив правил, где робот будет скрыт
  Каждое правило в массиве может быть строкой или массивом типа документа в полном или частичном варианте.
  Чтобы ограничить робота по редакции Битрикс24 укажите:
  - `b24` — для облака
  - `box` — для коробки
  Примеры:
  1. Исключить робота для коробочного Битрикс24
      ```js
      'FILTER': {
          EXCLUDE: [ 'box' ]
      }
      ```
  2. Отображать робота только для сделок и лидов CRM
      ```js
      'FILTER': {
          INCLUDE: [
              ['crm', 'CCrmDocumentDeal'],
              ['crm', 'CCrmDocumentLead']
          ]
      }
      ```
- `USE_PLACEMENT` `boolean` — необязательный. Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения:
  - `Y` — да
  - `N` — нет
- `PLACEMENT_HANDLER` `string` — необязательный. URL обработчика встройки на стороне приложения

### Объект PROPERTY

- `Name` `string` — необязательный. Наименование параметра
- `Description` `string` — необязательный. Описание параметра
- `Type` `string` — необязательный. Тип параметра. Базовые значения: 
    - `bool` — да или нет
    - `date` — дата
    - `datetime` — дата и время
    - `double` — число
    - `file` — файл
    - `int` — целое число 
    - `select` — список
    - `string` — строка
    - `text` — текст
    - `user` — пользователь
- `Options` `array` — необязательный. Массив значений параметра типа список `'TYPE': select'` вида:
  ```js
  [
      'value1': 'title1',
      'value2': 'title2',
      'value3': 'title3',
      'value4': 'title4'
  ]
  ```
- `Required` `boolean` — необязательный. Обязательность параметра. Возможные значения:
  - `Y` — да
  - `N` — нет
- `Multiple` `boolean` — необязательный. Множественность параметра. Возможные значения:
  - `Y` — да
  - `N` — нет
- `Default` `any` — необязательный. Значение параметра по умолчанию

## Ответ

HTTP-статус: 200

```json
{
    "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

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

- `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. Нет полей для обновления

## Примеры запроса

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"test_robot","FIELDS":{"NAME":"Отправить сообщение автору","USE_SUBSCRIPTION":"N","FILTER":{"INCLUDE":[["crm","CCrmDocumentDeal"]]}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.robot.update
```

### JS

```js
try
{
	const response = await $b24.callMethod(
		'bizproc.robot.update',
		{
			'CODE': 'test_robot',
			'FIELDS': {
				'NAME': 'Отправить сообщение автору',
				'USE_SUBSCRIPTION': 'N',
				'FILTER': {
					INCLUDE: [
						['crm', 'CCrmDocumentDeal']
					]
				}
			}
		}
	);
	
	const result = response.getData().result;
	alert("Успешно: " + result);
}
catch( error )
{
	alert("Error: " + error);
}
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.robot.update(
        code="test_robot",
        fields={
            "NAME": "Отправить сообщение автору",
            "USE_SUBSCRIPTION": "N",
            "FILTER": {
                "INCLUDE": [
                    [
                        "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}")
```

### PHP

```php
try {
    $result = $serviceBuilder
        ->getBizProcScope()
        ->robot()
        ->update(
            'robot_code',
            'https://example.com/handler',
            1,
            ['en' => 'Localized Name'],
            true,
            ['property1' => 'value1'],
            false,
            ['returnProperty1']
        );

    // Process the result
    if ($result->isSuccess()) {
        print_r($result->getCoreResponse()->getResponseData()->getResult());
    } else {
        print("Update failed.");
    }
} catch (Throwable $e) {
    print("An error occurred: " . $e->getMessage());
}
```

### BX24.js

```js
BX24.callMethod(
    'bizproc.robot.update',
    {
        'CODE': 'test_robot',
        'FIELDS': {
            'NAME': 'Отправить сообщение автору',
            'USE_SUBSCRIPTION': 'N',
            'FILTER': {
                INCLUDE: [
                    ['crm', 'CCrmDocumentDeal']
                ]
            }
        },
    },
    function(result)
    {
        if(result.error())
            alert("Error: " + result.error());
        else
            alert("Успешно: " + result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'bizproc.robot.update',
    [
        'CODE' => 'test_robot',
        'FIELDS' => [
            'NAME' => 'Отправить сообщение автору',
            'USE_SUBSCRIPTION' => 'N',
            'FILTER' => [
                'INCLUDE' => [
                    ['crm', 'CCrmDocumentDeal']
                ]
            ]
        ]
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.robot.update", b24.Params{
	"CODE": "test_robot",
	"FIELDS": b24.Params{
		"NAME":             "Отправить сообщение автору",
		"USE_SUBSCRIPTION": "N",
		"FILTER": b24.Params{
			"INCLUDE": []any{
				[]string{"crm", "CCrmDocumentDeal"},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("bizproc.robot.update: %w", err)
}

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

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-update.html