Update a rule; activated:false retires it

The rule

PATCH /api/v1/rules/{id}

cURL

curl --request PATCH \
  --url 'https://response.stateset.com/api/v1/rules/{id}' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "rule_name": "string",
  "rule_type": "string",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "activated": true,
  "conditions": {
    "any": [],
    "all": []
  },
  "actions": []
}'

200

{
  "object": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "type": "standard",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Path parameters

id · string (uuid) · required

The rule id.

Request body

UpdateRule

rule_name · string

rule_type · string

One of: escalation, qualification, response, routing.

description · string

activated · boolean

Set false to retire the rule.

conditions · 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.

actions · any[]

[{type, …}]. Types: collect_fields, fallback, handoff, include_sources, require_context, require_source_for_claims, require_verification, response_pattern, tag.

Response

Rule

object · string

id · string

name · string,null

type · string,null

description · string,null

activated · boolean

conditions · any

actions · any

agent_id · 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

cURL

curl --request PATCH \
  --url 'https://response.stateset.com/api/v1/rules/{id}' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "rule_name": "string",
  "rule_type": "string",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "activated": true,
  "conditions": {
    "any": [],
    "all": []
  },
  "actions": []
}'

200

{
  "object": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "type": "standard",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}