StateSet API Docs

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": []
}'

{
  "object": "string",
  "id": "string",
  "name": null,
  "type": null,
  "description": null,
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": null
}

PATCH

api

rules

{id}

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": []
}'

{
  "object": "string",
  "id": "string",
  "name": null,
  "type": null,
  "description": null,
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": null
}

Path parameters

string (uuid)

required

The rule id.

Request body

UpdateRule

string

One of: escalation, qualification, response, routing.

string

boolean

Set false to retire the rule.

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.

any[]

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

Response

Rule

string

string,null

boolean

any

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 --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": []
}'

{
  "object": "string",
  "id": "string",
  "name": null,
  "type": null,
  "description": null,
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": null
}

Overview

Workspace

Agents

Rules

Functions

Knowledge

Conversations

Responses

Evals

Analytics

Integrations

Changes

Update a rule; activated:false retires it

Path parameters

Request body

Response

Status codes

Access

​Path parameters

​Request body

​Response

​Status codes

​Access

Path parameters

Request body

Response

Status codes

Access