Ctrlk
Try Nected For Free
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update rule

Update an existing rule by entity ID. Send a partial request body with only the fields you want to change. Include the checksum from the last get/create/update/test when the API requires it for optimistic locking. Payload shape matches create (same type-specific fields); do not change type. The response returns data.checksum for use in the next update or publish.

Use the API reference below to try the endpoint.

Update rule

patch

Update an existing rule. Include checksum when required. Use examples for full decision-table update or full simpleRule/ruleSet style bodies.

Authorizations
Nected-API-KeystringRequired

Dev API key (Nected-API-Key header)

Path parameters
entity-idstringRequired

The rule's entity ID

Header parameters
Nected-BranchstringOptional

Branch name (optional)

Body

Partial update for an existing rule. Send only the fields you want to change.

  • Include checksum from the last get/create/update when the API requires optimistic locking.
  • Do not change type.
  • Full decision-table update example: Update/update_DT.json and examples/patch_rule_decisionTable.json.
  • For simpleRule / ruleSet, full-body style patches are shown in examples/patch_rule_simpleRule.json and patch_rule_ruleSet.json.
checksumstringOptional

From last get/create/update; required for optimistic locking when applicable

namestringOptional
descriptionstringOptional
dataSetIdstring · nullableOptional
customInputobjectOptional
conditionsobjectOptional
actionobjectOptional
settingsobjectOptional
decisionTableobject · nullableOptional
ruleSetPolicystringOptional
policystringOptional
dependencyMaparrayOptional
Other propertiesanyOptional
Responses
200

OK. Returns data.checksum.

application/json

Success response for Update rule (PATCH).

codestringOptional
messagestringOptional
patch
/dev/v1/rule/{entity-id}

Replace the example checksum values with the current value from Get rule by id for your entity.

Where to get the Checksum?

The API expects the current checksum of the rule for optimistic locking. If the checksum in your request does not match the rule’s latest checksum on the server, the call fails with a checksum mismatch error and the rule is not updated.

Recommended flow

  1. Call Get rule by id (GET /dev/v1/rule/{entity-id}) for the rule you want to change.

  2. From the response, copy data.checksum (the exact string returned by the API).

  3. Paste that value into your PATCH body as checksum (alongside the fields you are updating).

You can also obtain a valid checksum from:

  • Create rule — data.checksum in the 201 response, or

  • Update rule — data.checksum in the 200 response from your last successful update

Always use the latest checksum before each update if the rule may have changed.

PreviousCreate ruleNextTest Rule

Last updated