For AI agents: markdown of this page — /docs-content-en/entities/bizproc-robots/update.md documentation index — /llms.txt

Update an automation rule

PATCH /v1/bizproc-robots/:code

Updates the fields of a registered automation rule. Fields are passed flat at the JSON root — without a fields wrapper.

Parameters

Parameter Type Req. Description
code (path) string yes The automation rule code set at registration

Request fields (body)

Field Type Description
name string | object Automation rule name. A string or a localized object like {"en": "...", "de": "..."}
handler string Handler URL. The domain must match the application domain
documentType array Document type [module, object, type]. Values:
["crm", "CCrmDocumentLead", "LEAD"] — leads
["crm", "CCrmDocumentDeal", "DEAL"] — deals
["crm", "Bitrix\\Crm\\Integration\\BizProc\\Document\\Quote", "QUOTE"] — quotes
["crm", "Bitrix\\Crm\\Integration\\BizProc\\Document\\SmartInvoice", "SMART_INVOICE"] — invoices
["crm", "Bitrix\\Crm\\Integration\\BizProc\\Document\\Dynamic", "DYNAMIC_<entityTypeId>"] — smart processes, <entityTypeId> from the entityTypeId field in GET /v1/smart-processes
description string | object Automation rule description. A string or a localized object
authUserId number The user whose token is passed to the application when the automation rule is invoked. List: GET /v1/users
useSubscription string Whether to wait for a response from the application before continuing the rule: Y or N
properties object Automation rule input parameters
returnProperties object Automation rule output parameters
filter object INCLUDE / EXCLUDE rules by document type
usePlacement string Whether to open automation rule settings in a slider panel: Y or N
placementHandler string URL of the settings slider panel. Required when usePlacement: "Y"

Examples

Only an authorization key can update an automation rule — both examples send the authorization key and the Authorization: Bearer header. The session token is issued by OAuth authorization, is valid for 24 hours, and cannot be renewed — Passing the key.

curl — authorization key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/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": { "en": "Deal notification v2", "de": "Deal-Benachrichtigung v2" },
    "handler": "https://app.example.com/robots/deal-notify-v2"
  }'

JavaScript — authorization key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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: { en: 'Deal notification v2', de: 'Deal-Benachrichtigung v2' },
    handler: 'https://app.example.com/robots/deal-notify-v2',
  }),
})

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

Response fields

Field Type Description
id string The code of the updated automation rule — matches the code from the path

Response example

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

Error response example

422 — an automation rule with the given code was not found:

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

Errors

HTTP Code Description
403 OAUTH_REQUIRED The request was sent with an API key. Only an authorization key can update automation rules
401 TOKEN_MISSING Authorization key without the Authorization: Bearer header
401 WRONG_AUTH_SCHEME The authorization key was sent in the Authorization: Bearer header. The key goes in X-Api-Key, while Authorization: Bearer carries the session token
401 INVALID_SESSION The session token has expired or is invalid — authorize again
403 SCOPE_DENIED The key lacks the bizproc scope
422 BITRIX_ERROR Bitrix24 did not find an automation rule with the given code or rejected the update — reason in error.message

The full list of common API errors — Errors.

See also