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

Обновить действие

PATCH /v1/bizproc-activities/:code

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

Параметры

Параметр Тип Обяз. Описание
Параметрcode (path) Типstring Обяз.да ОписаниеСимвольный код действия

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

Поле Тип Описание
Полеname Типstring | object ОписаниеНазвание действия. Строка или локализованный объект вида {"ru": "...", "en": "..."}
Полеhandler Типstring ОписаниеURL обработчика действия. Домен совпадает с доменом приложения
Полеdescription Типstring | object ОписаниеОписание действия. Строка или локализованный объект
ПолеauthUserId Типnumber ОписаниеID пользователя, чей токен передаётся приложению при вызове действия. Список: GET /v1/users
ПолеuseSubscription Типstring ОписаниеЖдать ли ответа от приложения перед продолжением процесса: Y или N
Полеproperties Типobject ОписаниеВходные параметры действия
ПолеreturnProperties Типobject ОписаниеВыходные параметры действия
ПолеdocumentType Типarray ОписаниеТип документа: [модуль, объект, тип]
Поле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-авторизация и живёт 24 часа без продления — Передача ключа.

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/bizproc-activities/notify_manager" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": { "ru": "Уведомить руководителя отдела", "en": "Notify department manager" }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bizproc-activities/notify_manager', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: { ru: 'Уведомить руководителя отдела', en: 'Notify department manager' },
  }),
})

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

Поля ответа

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

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

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

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

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

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

Ошибки

HTTP Код Описание
HTTP401 КодTOKEN_MISSING ОписаниеПередан ключ авторизации без заголовка Authorization: Bearer
HTTP401 КодWRONG_AUTH_SCHEME ОписаниеКлюч авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии
HTTP401 КодINVALID_SESSION ОписаниеТокен сессии истёк или недействителен — пройдите авторизацию заново
HTTP403 КодOAUTH_REQUIRED ОписаниеЗапрос отправлен API-ключом. Обновлять действия можно только ключом авторизации
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 привязку не меняет. Смена на субдомен идёт только одиночным запросом — Доставка вызовов действий и роботов.

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