Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
review
/
rule
/
update
Update Review Rule
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/review/rule/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "rule_id": "31415926",
  "group_id": "31415926",
  "name": "Review Rule 1",
  "prompt": "Review rule prompt",
  "category_ids": [
    "1234567890"
  ],
  "risk_level": 10,
  "referenced_fields": [
    {
      "category_id": "1234567890",
      "category_name": "Invoice",
      "fields": [
        {
          "field_id": "1234567890",
          "field_name": "Invoice Code"
        }
      ],
      "tables": [
        {
          "table_id": "1234567890",
          "table_name": "Invoice Table",
          "fields": [
            {
              "field_id": "1234567890",
              "field_name": "Invoice Code"
            }
          ]
        }
      ]
    }
  ]
}
'
{
  "code": 200,
  "msg": "<string>"
}

Authorizations

x-ti-app-id
string
header
required
x-ti-secret-code
string
header
required

Body

application/json
workspace_id
string

Workspace ID

Example:

"1234567890"

rule_id
string

Review rule ID

Example:

"31415926"

group_id
string

Review rule group ID

Example:

"31415926"

name
string

Rule name

Example:

"Review Rule 1"

prompt
string

Rule prompt

Example:

"Review rule prompt"

category_ids
string[]

Category ID

risk_level
enum<integer>

Risk level

  • 10: High risk
  • 20: Medium risk
  • 30: Low risk
Available options:
10,
20,
30
referenced_fields
object[]

Response

200 - application/json

Successfully updated review rule

code
integer
required

Status code

Example:

200

msg
string
required

Status description