Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

Paste your workspace API key from Settings. Sent as Authorization: Bearer .

Path Parameters

id
string
required

The rule id, e.g. rule_9f2c4b1e8a7d4c3fb2e1d0a9c8b7a6f5.

Body

title
string
required
Maximum string length: 255
condition
string
required
guidance
string
default:""
outcome_guidance
enum<string>
default:ADVISORY
  • ACCEPTED - ACCEPTED
  • REJECTED - REJECTED
  • PENDING - PENDING
  • ADVISORY - ADVISORY
Available options:
ACCEPTED,
REJECTED,
PENDING,
ADVISORY
score_delta
integer
default:0
Required range: -100 <= x <= 100
document_types
string[]
Maximum string length: 128
document_descriptions
string[]
Maximum string length: 128
document_subtypes
string[]
Maximum string length: 128
status
enum<string>
default:active
  • active - active
  • disabled - disabled
Available options:
active,
disabled

Response

The updated rule.

id
string
required

Prefixed id, e.g. rule_9f2c….

created_at
string
required
status
enum<string>
required
  • active - active
  • disabled - disabled
Available options:
active,
disabled
title
string
required
condition
string
required
guidance
string
required
outcome_guidance
enum<string>
required
  • ACCEPTED - ACCEPTED
  • REJECTED - REJECTED
  • PENDING - PENDING
  • ADVISORY - ADVISORY
Available options:
ACCEPTED,
REJECTED,
PENDING,
ADVISORY
score_delta
integer
required

Added to risk_score when the rule triggers.

document_types
string[]
required
object
string
default:rule
document_descriptions
string[]
document_subtypes
string[]