Update categorisation rule

PATCH https://app.speybooks.com/api/v1/categorisation-rules/{id}

Updates one or more fields on an existing rule. Only the fields included in the request body are modified (partial update semantics). Emits a signal to the global aggregation pipeline on change.

Path parameters

id integer required
Rule ID (numeric, not prefixed).

Body parameters

active boolean optional
Whether the rule is active.
description string optional
Rule description (max 500 characters).
field string optional
Transaction field to match against.
descriptioncontact_nameamountreferencemetadata.categorymetadata.projectmetadata.departmentmetadata.tag
name string optional
Rule display name (1-100 characters).
operator string optional
Match operator.
containsequalsstarts_withends_withgreater_thanless_thanregex
priority integer optional
Rule priority (0-999).
targetAccountId string optional
Target account ID (e.g. acc_4000).
value string optional
Value to match (1-500 characters).

Response

200 Rule updated.
Show response fields
id integer
updated boolean

Error codes

400 Validation error: invalid regex, invalid account ID.
404 Rule or target account not found.