HEherondata
Rules

Update rule by heron_id

Update a rule

put/api/rules/{heron_id}

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/rules/{heron_id}
  • Auth
    API key in header x-api-key

Path parameters

heron_idstring required

Request body

Example request

{
  "rule": {
    "condition": "equal",
    "created": "2026-09-21T23:44:37.124813",
    "date_range": "last_180_days",
    "group": "data_quality_datasource",
    "heron_id": "rul_NMSXApUPFgZ5RaC8Q7brLJ",
    "last_updated": "2026-11-02T23:44:37.124855",
    "metric_label": "unique_transactions",
    "name": "notify_if_debt_investment_count_gt_0_last_180d",
    "selector": {
      "is_portfolio": true
    },
    "value": 42.42,
    "value_str": "mrc_12345678ijwdd321d921"
  }
}

Response

Updated

Example response

{
  "rule": {
    "condition": "equal",
    "created": "2026-09-21T23:44:37.124813",
    "date_range": "last_180_days",
    "group": "data_quality_datasource",
    "heron_id": "rul_NMSXApUPFgZ5RaC8Q7brLJ",
    "last_updated": "2026-11-02T23:44:37.124855",
    "metric_label": "unique_transactions",
    "name": "notify_if_debt_investment_count_gt_0_last_180d",
    "selector": {
      "is_portfolio": true
    },
    "value": 42.42,
    "value_str": "mrc_12345678ijwdd321d921"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.