Recomms AI
  1. Business Rules
Recomms AI
  • Documentation
  • Recomms AI SDK
  • Items
    • Create an item
      POST
    • Update an item
      PATCH
    • Get items
      GET
    • Get item by ID
      GET
    • Delete item
      DELETE
    • Get item side info
      GET
    • Create item side info
      POST
    • Delete item side info
      DELETE
    • Reset items
      POST
  • Users
    • Create a user
      POST
    • Update a user
      PATCH
    • Get users
      GET
    • Get user by ID
      GET
    • Delete user
      DELETE
    • Get user side info
      GET
    • Create user side info
      POST
    • Delete user side info
      DELETE
    • Reset users
      POST
  • Interactions
    • Record an interaction
      POST
    • Get interactions
      GET
    • Delete an interaction
      DELETE
    • Record multiple interactions
      POST
    • Reset interactions
      POST
  • Business Rules
    • Create a new business rule
      POST
    • List business rules
      GET
    • Get business rule by ID
      GET
    • Update business rule
      PATCH
    • Delete business rule
      DELETE
  • Recommendations
    • Get item recommendations for a user
    • Get user recommendations for an item
    • Get similar users
    • Predict scores for user-item pairs
    • Predict scores for a batch of user-item combinations
    • Search for items
    • Search for users
    • Get top items
  1. Business Rules

Create a new business rule

POST
https://api.recomms.ai/{database}/business-rules
Business Rules
Add a new business rule to the specified database.

Request

Path Params
database
string 
required
The ID of the database to operate on
Body Params application/json
resource
enum<string> 
required
The resource type this rule applies to
Allowed values:
usersitems
rule
enum<string> 
required
The type of rule
Allowed values:
boosterfilter
field
string 
required
The field this rule applies to
condition
enum<string> 
required
The condition for the rule
Allowed values:
><>=<===innot incontainsnot contains
value
string 
required
The value to compare, use ${value} for dynamic value
enabled
boolean 
optional
Whether the rule is enabled
Default:
true
default
boolean 
optional
Whether this is a default rule
Default:
false
Example
{
  "resource": "users",
  "rule": "booster",
  "field": "string",
  "condition": ">",
  "value": "string",
  "enabled": true,
  "default": false
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '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": false
}'

Responses

🟢201Created
application/json
Successful operation
Body
status
enum<string> 
optional
Allowed value:
success
id
integer 
optional
The ID of the created or affected resource
Example
{
  "status": "success",
  "id": 0
}
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Modified at 2025-03-13 17:00:04
Previous
Reset interactions
Next
List business rules
Built with