Update categorisation rule

PATCHhttps://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).

Path parameters

idintegerrequired

Rule ID (numeric, not prefixed).

Body parameters

activebooleanoptional

Whether the rule is active.

descriptionstringoptional

Rule description (max 500 characters).

fieldstringoptional

Transaction field to match against.

descriptioncontact_nameamountreferencemetadata.categorymetadata.projectmetadata.departmentmetadata.tag

namestringoptional

Rule display name (1-100 characters).

operatorstringoptional

Match operator.

containsequalsstarts_withends_withgreater_thanless_thanregex

priorityintegeroptional

Rule priority (0-999).

targetAccountIdstringoptional

Target account ID (e.g. acc_4000).

valuestringoptional

Value to match (1-500 characters).

Response

200Rule updated.

Show response fields

idinteger

updatedboolean

Error codes

400Validation error: invalid regex, invalid account ID.

404Rule or target account not found.

RequestPATCH/v1/categorisation-rules/{id}curl

curl -X PATCH https://api.speybooks.com/v1/categorisation-rules/5 \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "priority": 80 }'

Response200

{
  "success": true,
  "data": {
    "id": 5,
    "updated": true
  }
}