UpdateRule

Updates an existing rule.

PUT /api/v1/rules

UpdateRule

cURL

curl --request PUT \
  --url https://api.siftstack.com/api/v1/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "conditions": [
    {
      "expression": {},
      "actions": [
        {
          "actionType": "ACTION_KIND_UNSPECIFIED",
          "configuration": {},
          "ruleActionId": "<string>"
        }
      ],
      "ruleConditionId": "<string>"
    }
  ],
  "metadata": [
    {
      "key": {
        "name": "<string>",
        "type": "METADATA_KEY_TYPE_UNSPECIFIED",
        "archivedDate": "2023-11-07T05:31:56Z",
        "isArchived": true
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "isArchived": true
    }
  ],
  "ruleId": "<string>",
  "assetId": "<string>",
  "isEnabled": true,
  "organizationId": "<string>",
  "versionNotes": "<string>",
  "clientKey": "<string>",
  "assetConfiguration": {
    "assetIds": [
      "<string>"
    ],
    "tagIds": [
      "<string>"
    ]
  },
  "isExternal": true,
  "isArchived": true,
  "isLiveEvaluationEnabled": true
}
'

200

{
  "ruleId": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

UpdateRuleRequest is used to create or update a rule. If the rule_id or client_key is provided, the rule will be updated. If not, a new rule will be created.

UpdateRuleRequest is used to create or update a rule. If the rule_id or client_key is provided, the rule will be updated. If not, a new rule will be created.

name · string · required

description · string · required

conditions · object[] · required

Show child attributes

metadata · object[] · required

Show child attributes

ruleId · string

assetId · string

Deprecated - use asset_configuration instead.

isEnabled · boolean

Deprecated - use DeleteRule instead.

organizationId · string

versionNotes · string

clientKey · string

assetConfiguration · object

Show child attributes

contextualChannels · object

Show child attributes

isExternal · boolean

isArchived · boolean

isLiveEvaluationEnabled · boolean

If set to true then this rule will be evaluated on live data, otherwise live rule evaluation will be disabled. This rule can still be used, however, in report generation. If this value is null then the original value is preserved.

This is a request, not a guarantee. When combined with BatchUpdateRulesRequest.override_expression_validation = true, a true value here can be silently overridden to false if UDF inlining fails (the rule is still persisted, just with live evaluation disabled). Re-send this request with the underlying issue resolved -- e.g. the referenced channels populated, or the expression simplified -- to flip it back on.

Response

200

application/json

A successful response.

ruleId · string · required