Для 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 по типу документа
usePlacement string Открывать настройки робота в выдвижной панели: Y или N
placementHandler string URL выдвижной панели настроек. Обязателен при usePlacement: "Y"

Примеры

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

curl — ключ авторизации

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 — ключ авторизации

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()

Поля ответа

Поле Тип Описание
id string Код обновлённого робота — совпадает с code из пути

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

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

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

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

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

Ошибки

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

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

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

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

Запрос без поля handler привязку не меняет. Обновление любых других полей оставляет доставку такой, какой она была после регистрации.

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

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