Error
A valid request URL is required to generate request examples{
"id": "<string>",
"created_at": "<string>",
"status": "active",
"title": "<string>",
"condition": "<string>",
"guidance": "<string>",
"outcome_guidance": "ACCEPTED",
"score_delta": 123,
"document_types": [
"<string>"
],
"object": "rule",
"document_descriptions": [
"<string>"
],
"document_subtypes": [
"<string>"
]
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}Rules
Update a rule
Send any subset of fields. Set status to disabled to stop it running.
PATCH
/
api
/
v1
/
rules
/
{id}
/
Error
A valid request URL is required to generate request examples{
"id": "<string>",
"created_at": "<string>",
"status": "active",
"title": "<string>",
"condition": "<string>",
"guidance": "<string>",
"outcome_guidance": "ACCEPTED",
"score_delta": 123,
"document_types": [
"<string>"
],
"object": "rule",
"document_descriptions": [
"<string>"
],
"document_subtypes": [
"<string>"
]
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>"
}
}Authorizations
Paste your workspace API key from Settings. Sent as Authorization: Bearer .
Path Parameters
The rule id, e.g. rule_9f2c4b1e8a7d4c3fb2e1d0a9c8b7a6f5.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Maximum string length:
255ACCEPTED- ACCEPTEDREJECTED- REJECTEDPENDING- PENDINGADVISORY- ADVISORY
Available options:
ACCEPTED, REJECTED, PENDING, ADVISORY Required range:
-100 <= x <= 100Maximum string length:
128Maximum string length:
128Maximum string length:
128active- activedisabled- disabled
Available options:
active, disabled Response
The updated rule.
Prefixed id, e.g. rule_9f2c….
active- activedisabled- disabled
Available options:
active, disabled ACCEPTED- ACCEPTEDREJECTED- REJECTEDPENDING- PENDINGADVISORY- ADVISORY
Available options:
ACCEPTED, REJECTED, PENDING, ADVISORY Added to risk_score when the rule triggers.