Recomms AI

Update business rule

PATCH

https://api.recomms.ai/{database}/business-rules/{id}

Business Rules

Modify an existing business rule in the specified database.

Request

Path Params

database

string

required

The ID of the database to operate on

integer

required

ID of the business rule

Body Params application/json

resource

enum<string>

optional

The resource type this rule applies to

Allowed values:

usersitems

rule

enum<string>

optional

The type of rule

Allowed values:

boosterfilter

field

string

optional

The field this rule applies to

condition

enum<string>

optional

The condition for the rule

Allowed values:

><>=<===innot incontainsnot contains

value

string

optional

The value to compare, use ${value} for dynamic value

enabled

boolean

optional

Whether the rule is enabled

default

boolean

optional

Whether this is a default rule

Example

{
  "resource": "users",
  "rule": "booster",
  "field": "string",
  "condition": ">",
  "value": "string",
  "enabled": true,
  "default": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.recomms.ai//business-rules/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "resource": "users",
    "rule": "booster",
    "field": "string",
    "condition": ">",
    "value": "string",
    "enabled": true,
    "default": true
}'

Responses

🟢200OK

application/json

Successful operation

Body

status

enum<string>

optional

Allowed value:

success

integer

optional

The ID of the created or affected resource

Example

{
  "status": "success",
  "id": 0
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-03-13 17:00:20

Get business rule by ID

Delete business rule