Rule Sets

Create a rule set with nested rules

Creates a RuleSet and any nested conditions in rules[]. Requires scope rules:write.

post/api/v1/rule_sets

Request

Base URL: https://getscaleforge.com
URL: https://getscaleforge.com/api/v1/rule_sets
Auth: HTTP bearer

Request body

Example request

{
  "rule_set": {
    "name": "Pause losers",
    "action": "pause",
    "bid_step": 0.05,
    "bid_min": 2,
    "bid_max": 8,
    "schedule_type": "interval",
    "schedule_value": 30,
    "schedule_start_hour": 9,
    "schedule_end_hour": 23,
    "data_period": "today",
    "cooldown_minutes": 60,
    "max_daily_actions": 50,
    "target_level": "adset"
  },
  "rules": [
    {
      "metric": "cpl",
      "operator": "gt",
      "value": 5
    }
  ]
}

Response

Created

Example response

{
  "data": {
    "id": 55,
    "name": "Pause losers",
    "action": "pause",
    "bid_step": 0.05,
    "bid_min": 2,
    "bid_max": 8,
    "schedule_type": "interval",
    "schedule_value": 30,
    "data_period": "today",
    "enabled": true,
    "cooldown_minutes": 60,
    "max_daily_actions": 50,
    "target_level": "adset",
    "rules": [
      {
        "id": 101,
        "metric": "cpl",
        "operator": "gt",
        "value": 5
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.