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

Примеры

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

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

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

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

Поля ответа

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

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

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

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

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

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

Ошибки

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

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