Skip to content
OpenBot

agents.updateRule

PATCH
/v1/agents/{agentId}/rules/{ruleId}
curl --request PATCH \
  --url https://example.com/v1/agents/example/rules/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected": 1, "text": "example", "status": "active" }'

Changes the text of a Rule, confirms a proposed Rule, or retires a Rule.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agentId
required
string
>= 1 characters <= 128 characters
ruleId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
expected
required
integer
<= 9007199254740991
text
string
>= 1 characters <= 4000 characters
status
string
Allowed values: active retired

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
id
required
string
agent
required
string
>= 1 characters <= 128 characters
author
required
Any of:
object
_tag
required
string
Allowed values: Person
userId
required
string
text
required
string
status
required
string
Allowed values: active proposed retired
version
required
integer
<= 9007199254740991
createdAt
required
number
updatedAt
required
number

Example 

{
  "author": {
    "_tag": "Person"
  },
  "status": "active"
}

400

Section titled “400”

AgentInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AgentInvalid
message
required
string

Example 

{
  "_tag": "AgentInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

AgentNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: AgentNotFound
agent
required
string

Example 

{
  "_tag": "AgentNotFound"
}

409

Section titled “409”

AgentConflict

Media typeapplication/json
object
_tag
required
string
Allowed values: AgentConflict
message
required
string

Example 

{
  "_tag": "AgentConflict"
}

503

Section titled “503”

AuthorizationUnavailable | AgentStorageUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}