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 Required Description
Parametercode (path) Typestring Requiredyes DescriptionThe automation rule code set at registration

Request fields (body)

Field Type Description
Fieldname Typestring | object DescriptionAutomation rule name. A string or a localized object like {"en": "...", "de": "..."}
Fieldhandler Typestring DescriptionHandler URL. The domain must match the application domain
FielddocumentType Typearray DescriptionDocument 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
Fielddescription Typestring | object DescriptionAutomation rule description. A string or a localized object
FieldauthUserId Typenumber DescriptionThe user whose token is passed to the application when the automation rule is invoked. List: GET /v1/users
FielduseSubscription Typestring DescriptionWhether to wait for a response from the application before continuing the rule: Y or N
Fieldproperties Typeobject DescriptionAutomation rule input parameters
FieldreturnProperties Typeobject DescriptionAutomation rule output parameters
Fieldfilter Typeobject DescriptionLimits which documents the automation rule is available for. An empty object {} removes the restriction.
INCLUDE lists the conditions under which the automation rule is available, EXCLUDE those under which it is not. A condition is a document type prefix, for example ["crm", "CCrmDocumentDeal"], or a Bitrix24 edition: "b24" for cloud, "box" for on-premise.
Example: {"INCLUDE": [["crm", "CCrmDocumentDeal"], ["crm", "CCrmDocumentLead"]]}.
Write the keys in uppercase: with lowercase keys the field is accepted but restricts nothing. A value that is not an object returns 422 BITRIX_ERROR
FieldusePlacement Typestring DescriptionWhether to open the automation rule settings in a slider panel: Y or N
FieldplacementHandler Typestring DescriptionURL of the settings slider panel. Required when usePlacement: "Y"

Examples

Only an OAuth application key can update an automation rule — both examples send an OAuth application 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 — OAuth application

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 — OAuth application

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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.id Typestring DescriptionThe 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!",
    "b24Code": "ERROR_ACTIVITY_NOT_FOUND"
  }
}

Errors

HTTP Code Description
HTTP403 CodeOAUTH_REQUIRED DescriptionThe request was sent with an API key. Only an authorization key can update automation rules
HTTP401 CodeTOKEN_MISSING DescriptionThe authorization key was sent without the Authorization: Bearer header
HTTP401 CodeWRONG_AUTH_SCHEME DescriptionThe authorization key was sent in the Authorization: Bearer header. The key goes in X-Api-Key, while Authorization: Bearer carries the session token
HTTP401 CodeINVALID_SESSION DescriptionThe session token has expired or is invalid — authorize again
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the bizproc scope
HTTP400 CodeSERVER_APP_MISMATCH DescriptionThe new handler points to a Black Hole subdomain that has no server of this app behind it — the subdomain does not exist, or the server belongs to another app
HTTP409 CodeBIZPROC_MODULE_NOT_ENABLED DescriptionBusiness Processes are not available on the account: the module is not included in the plan, or it is switched off in account settings. Ask an account administrator to enable Business Processes — until then the method answers the same way for any number of retries
HTTP503 CodeBIZPROC_CALLBACK_RESOLVE_FAILED DescriptionThe platform could not match the handler to a server. The automation rule was not updated — retry the request
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 did not find an automation rule with the given code or rejected the update — the reason is in error.message

The full list of common API errors — Errors.

Known specifics

Moving the handler to a Black Hole subdomain switches the automation rule to reliable delivery. Moving back to an address on your own domain restores direct calls without retries, and a request without the handler field leaves the binding unchanged. A switch to a subdomain must be sent as a single request — Activity and automation rule callback delivery.

See also