Reorder Rules
Replaces the household's rule priority order and returns the rules in their new order. The first ID has the highest priority.
Submit every active rule ID exactly once. Missing, duplicate, or foreign IDs return invalid_rule_ids. Reordering does not reapply rules to existing transactions.
Authorization
PersonalApiToken Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.
In: header
Path Parameters
Request Body
application/json
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/households/string/rules/reorder" \ -H "Content-Type: application/json" \ -d '{ "rule_ids": [ "Rl9cF3nV7sQa" ] }'{ "rules": [ { "id": "Rl9cF3nV7sQa", "priority": 1, "account_ids": [ "Ac7kP2mN9qRs" ], "merchant_ids": [ "Mr9dL3xT6bQa" ], "category_ids": [ "Ct5nR8wY1jFu" ], "amount_filter": { "direction": "income", "operator": "equals", "value": "68.42", "value_upper": "100.00" }, "penny_detailed_categories": [ "RENT_AND_UTILITIES_RENT" ], "name_conditions": [ { "pattern": "BLUE BOTTLE", "mode": "contains" } ], "filter_uncategorized": true, "set_category_id": "Ct5nR8wY1jFu", "set_merchant_id": "Mr9dL3xT6bQa", "apply_tag_ids": [ "Tg8qN1cK5rWd" ], "set_hidden": true, "set_needs_review": true, "applied_count": 18 } ]}Create Rule POST
Creates a transaction rule at the highest priority in the household. Define matching conditions and actions such as assigning a category or merchant, adding…
Dry Run POST
Previews which visible transactions match a proposed rule's conditions without saving a rule or changing transactions. Returns overall match and transaction…