> ## 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; activated:false retires it

> The rule

### Path parameters

<ParamField path="id" type="string (uuid)" required>
  The rule id.
</ParamField>

### Request body

`UpdateRule`

<ParamField body="rule_name" type="string" />

<ParamField body="rule_type" type="string">
  One of: escalation, qualification, response, routing.
</ParamField>

<ParamField body="description" type="string" />

<ParamField body="activated" type="boolean">
  Set false to retire the rule.
</ParamField>

<ParamField body="conditions" type="object">
  \{any|all: \[\{field, operator, value}]}. Fields: company\_size, confidence, intent, knowledge\_sources, latest\_message, missing\_required\_fields, timeline. Operators: contains\_any, eq, exists, gte, in, lt, not\_empty.
</ParamField>

<ParamField body="actions" type="any[]">
  \[\{type, ...}]. Types: collect\_fields, fallback, handoff, include\_sources, require\_context, require\_source\_for\_claims, require\_verification, response\_pattern, tag.
</ParamField>

### Response

`Rule`

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

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

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

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

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

<ResponseField name="activated" type="boolean" />

<ResponseField name="conditions" type="any" />

<ResponseField name="actions" type="any" />

<ResponseField name="agent_id" type="string,null" />

### Status codes

| Code  | Meaning                                                  |
| ----- | -------------------------------------------------------- |
| `200` | The rule                                                 |
| `400` | Invalid request. `issues` names the offending field(s).  |
| `401` | Missing, invalid, or expired API key.                    |
| `403` | The key lacks a required scope.                          |
| `404` | Not found, or not in the organization that owns the key. |
| `429` | Rate limit exceeded.                                     |

### Access

|                |                        |
| -------------- | ---------------------- |
| Required scope | `agents:write`         |
| Rate limit     | 30 requests per minute |

<RequestExample>
  ```bash cURL theme={null}
  curl --request PATCH \
    --url 'https://response.stateset.com/api/v1/rules/{id}' \
    --header 'Authorization: Bearer YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "rule_name": "string",
    "rule_type": "string",
    "description": "string",
    "activated": true,
    "conditions": {
      "any": [],
      "all": []
    },
    "actions": []
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "object": "string",
    "id": "string",
    "name": null,
    "type": null,
    "description": null,
    "activated": true,
    "conditions": null,
    "actions": null,
    "agent_id": null
  }
  ```
</ResponseExample>