> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a rule by ID

> Update an existing rule. **Required scope:** write

Update an existing rule.

**Required scope:** `write`

### Path parameters

<ParamField path="id" type="string" required>
  Rule ID
</ParamField>

### Request body

`UpdateRuleRequest`

<ParamField body="confidence" type="number (float)">
  Confidence factor (0.0 - 1.0)
</ParamField>

<ParamField body="description" type="string">
  New description for the rule
</ParamField>

<ParamField body="enabled" type="boolean">
  Whether the rule is enabled
</ParamField>

<ParamField body="priority" type="integer (int32)">
  Priority for rule ordering (higher = more priority)
</ParamField>

<ParamField body="test_cases" type="RuleTestCaseRequest[]">
  Replace rule test cases.
</ParamField>

### Response

`RuleResponse`

<ResponseField name="body_count" type="integer" required />

<ResponseField name="confidence" type="number (float)" required />

<ResponseField name="description" type="string" />

<ResponseField name="enabled" type="boolean" required />

<ResponseField name="head_args" type="string[]" required />

<ResponseField name="head_predicate" type="string" required />

<ResponseField name="id" type="string" required />

<ResponseField name="name" type="string" required />

<ResponseField name="priority" type="integer (int32)" required />

<ResponseField name="test_case_count" type="integer" required />

<ResponseField name="test_cases" type="RuleTestCaseResponse[]" required>
  <Expandable title="RuleTestCaseResponse">
    <ResponseField name="expected_output" type="object" required />

    <ResponseField name="id" type="string" required />

    <ResponseField name="input_bindings" type="object" required />

    <ResponseField name="name" type="string" />

    <ResponseField name="should_fire" type="boolean" required />
  </Expandable>
</ResponseField>

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | Rule updated                                       |
| `400` | Invalid request                                    |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `404` | Rule not found                                     |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request PATCH \
    --url 'https://api.nsr.stateset.com/api/v1/rules/{id}' \
    --header 'X-API-Key: YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "confidence": 7.5,
    "description": "Two-person tent, green — replacement for damaged pole set.",
    "enabled": true,
    "priority": 1,
    "test_cases": [
      {
        "expected_output": {},
        "input_bindings": {},
        "name": "Two-Person Tent",
        "should_fire": true
      }
    ]
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "body_count": 1,
    "confidence": 7.5,
    "description": "Two-person tent, green — replacement for damaged pole set.",
    "enabled": true,
    "head_args": [
      "string"
    ],
    "head_predicate": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Two-Person Tent",
    "priority": 1,
    "test_case_count": 1,
    "test_cases": [
      {
        "expected_output": {},
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "input_bindings": {},
        "name": "Two-Person Tent",
        "should_fire": true
      }
    ]
  }
  ```
</ResponseExample>