Skip to main content
DELETE
Archive a rule. Rules are never deleted, so numbers are never reused: an archived rule is hidden, keeps its number and can't be added to a profile.

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

Query Parameters

force
boolean

A rule profiles use is refused (422, naming them) unless force=true, which takes it out of them first.

Response

The archived 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