Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-robots/update.md индекс документации — /llms.txt

Обновить робота

PATCH /v1/bizproc-robots/:code

Обновляет поля зарегистрированного робота. Поля передаются плоско в корне JSON — без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
Параметрcode (path) Типstring Обяз.да ОписаниеКод робота, заданный при регистрации

Поля запроса (body)

Поле Тип Описание
Полеname Типstring | object ОписаниеНазвание робота. Строка или локализованный объект вида {"ru": "...", "en": "..."}
Полеhandler Типstring ОписаниеURL обработчика. Домен должен совпадать с доменом приложения
ПолеdocumentType Типarray ОписаниеТип документа [модуль, объект, тип]. Значения:
["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_<entityTypeId>"] — смарт-процессы, <entityTypeId> из поля entityTypeId в GET /v1/smart-processes
Полеdescription Типstring | object ОписаниеОписание робота. Строка или локализованный объект
ПолеauthUserId Типnumber ОписаниеПользователь, чей токен передаётся приложению при вызове робота. Список: GET /v1/users
ПолеuseSubscription Типstring ОписаниеЖдать ли ответа приложения перед продолжением правила: Y или N
Полеproperties Типobject ОписаниеВходные параметры робота
ПолеreturnProperties Типobject ОписаниеВыходные параметры робота
Полеfilter Типobject ОписаниеОграничивает, для каких документов робот доступен. Пустой объект {} снимает ограничение.
INCLUDE — правила, при которых робот доступен, EXCLUDE — при которых недоступен. Правило — начало типа документа, например ["crm", "CCrmDocumentDeal"], или редакция Битрикс24: "b24" — облако, "box" — коробка.
Пример: {"INCLUDE": [["crm", "CCrmDocumentDeal"], ["crm", "CCrmDocumentLead"]]}.
Ключи пишутся заглавными: со строчными поле принимается, но ничего не ограничивает. Значение не объект — 422 BITRIX_ERROR
ПолеusePlacement Типstring ОписаниеОткрывать настройки робота в выдвижной панели: Y или N
ПолеplacementHandler Типstring ОписаниеURL выдвижной панели настроек. Обязателен при usePlacement: "Y"

Примеры

Обновлять робота можно только ключом OAuth-приложения — оба примера отправляют ключ OAuth-приложения и заголовок Authorization: Bearer. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — Передача ключа.

curl — OAuth-приложение

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/bizproc-robots/deal_notify" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": { "ru": "Уведомление по сделке — v2", "en": "Deal notification v2" },
    "handler": "https://app.example.com/robots/deal-notify-v2"
  }'

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bizproc-robots/deal_notify', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: { ru: 'Уведомление по сделке — v2', en: 'Deal notification v2' },
    handler: 'https://app.example.com/robots/deal-notify-v2',
  }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.id Типstring ОписаниеКод обновлённого робота — совпадает с code из пути

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": "deal_notify"
  }
}

Пример ответа при ошибке

422 — робот с указанным кодом не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Activity or Robot not found!",
    "b24Code": "ERROR_ACTIVITY_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
HTTP403 КодOAUTH_REQUIRED ОписаниеЗапрос отправлен API-ключом. Обновлять роботов можно только ключом авторизации
HTTP401 КодTOKEN_MISSING ОписаниеКлюч авторизации без заголовка Authorization: Bearer
HTTP401 КодWRONG_AUTH_SCHEME ОписаниеКлюч авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии
HTTP401 КодINVALID_SESSION ОписаниеТокен сессии истёк или недействителен — пройдите авторизацию заново
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа bizproc
HTTP400 КодSERVER_APP_MISMATCH ОписаниеНовый handler ведёт на субдомен Black Hole, за которым нет сервера этого приложения — субдомена не существует либо сервер принадлежит другому приложению
HTTP409 КодBIZPROC_MODULE_NOT_ENABLED ОписаниеБизнес-процессов на портале нет: модуль не входит в тариф либо выключен в настройках портала. Попросите администратора портала включить бизнес-процессы — до этого метод отвечает так же при любом числе повторов
HTTP503 КодBIZPROC_CALLBACK_RESOLVE_FAILED ОписаниеПлатформе не удалось сопоставить обработчик с сервером. Робот не обновлён — повторите запрос
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 не нашёл робота с указанным кодом или отклонил обновление — причина в error.message

Полный список общих ошибок API — Ошибки.

Известные особенности

Смена обработчика на субдомен Black Hole переключает робота на надёжную доставку. Обратная смена — на адрес своего домена — возвращает прямые вызовы без повторов, а запрос без поля handler привязку не меняет. Смена на субдомен идёт только одиночным запросом — Доставка вызовов действий и роботов.

Смотрите также