RuleService

UpdateRule

Updates an existing rule.

put/api/v1/rules

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/rules
  • Auth: HTTP bearer

Request body

ruleIdstring
namestring required
descriptionstring required
assetIdstring

Deprecated - use asset_configuration instead.

isEnabledboolean

Deprecated - use DeleteRule instead.

organizationIdstring
versionNotesstring
clientKeystring
isExternalboolean
isArchivedboolean
isLiveEvaluationEnabledboolean

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.

savedExplorationIdstring

ID of the saved exploration linked to this rule. When set, changing this value creates a new rule version. Cleared by sending an empty string.

Response

A successful response.

ruleIdstring required

Changes

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