Deactivate Rules

Deactivate rules by rule pack, import, scenario, or specific IDs

POST /api/policies/rules/deactivate

Deactivate Rules

cURL

curl --request POST \
  --url https://api.example.com/api/policies/rules/deactivate \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule_pack_id": "<string>",
  "import_id": "<string>",
  "rule_pack_scenario_id": "<string>",
  "rule_ids": [
    {}
  ]
}
'

200 OK

{
  "deactivated_custom_count": 2,
  "deactivated_custom_rule_ids": [
    "cust_abc123_require_risk_disclosure",
    "cust_abc123_past_performance_disclaimer"
  ],
  "deactivated_default_count": 47,
  "deactivated_default_rule_ids": [
    "signal_mnpi_leak",
    "signal_promissory_tone"
  ],
  "errors": []
}

Deactivate rules so they are skipped during validation. Custom rules are soft-deactivated (preserved for audit trail). Default rules are stored as deactivated on your customer record.

Request Body

rule_pack_id · string

Deactivate all rules in a rule pack (e.g., sec_finra_comms_v2)

import_id · string

Deactivate all custom rules from this import

rule_pack_scenario_id · string

Deactivate all default rules in a scenario (e.g., scenario_email_general)

rule_ids · array

Array of rule ID strings to deactivate (custom or default)

At least one field is required. Multiple fields can be combined in a single request.

Response

deactivated_custom_count · integer

Number of custom rules deactivated

deactivated_custom_rule_ids · array

List of deactivated custom rule IDs

deactivated_default_count · integer

Number of default rules deactivated

deactivated_default_rule_ids · array

List of deactivated default rule IDs

errors · array

List of error messages for rules that could not be deactivated. Empty array when no errors.

200 OK

{
  "deactivated_custom_count": 2,
  "deactivated_custom_rule_ids": [
    "cust_abc123_require_risk_disclosure",
    "cust_abc123_past_performance_disclaimer"
  ],
  "deactivated_default_count": 47,
  "deactivated_default_rule_ids": [
    "signal_mnpi_leak",
    "signal_promissory_tone"
  ],
  "errors": []
}

Example

cURL — by rule pack

curl -X POST "https://{api-url}/api/policies/rules/deactivate" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rule_pack_id": "sec_finra_comms_v2"}'