Skip to main content
PUT
Change a rule's text; every profile using it gets the new text. Archived rules can't be changed.

Authorizations

Authorization
string
header
required

A workspace token in the Bearer scheme. The workspace must have the Connect app enabled.

Path Parameters

number
integer
required

The rule's number

Required range: x >= 1

Body

application/json
text
string
required

One short instruction for the AI that reads PDFs and images, e.g. "Supplier numbers go in the order reference". It can't change the output format. To set a GOBL addon, name it with the word addon: "Use the es-verifactu-v1 addon" (a profile can use one addon). A workspace can have up to 1000 rules.

Maximum string length: 200
Example:

"Use the de-xrechnung-v3 addon"

Response

The rule

number
integer

Identifies the rule in its workspace for good: numbers are never reused. Profiles list rules by number.

id
string
text
string
addon
string

The GOBL addon the rule names, if any

profiles
string[]

Ids of the profiles using the rule

created_at
string<date-time>
updated_at
string<date-time>
archived_at
string<date-time>

Set on an archived rule