Penny Docs
Rules

Patch Rule

PATCH
/v1/households/{household_id}/rules/{rule_id}

Changes only supplied rule fields, preserving the latest omitted conditions and actions under a database lock. Supplied lists and amount_filter replace the whole field; null clears nullable fields. Priority stays unchanged.

A supplied amount filter requires an explicit, non-null currency. Omit the whole amount_filter field to preserve its thresholds and currency.

Authorization

PersonalApiToken
AuthorizationBearer <token>

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

household_id*Household Id
rule_id*Rule Id

Request Body

application/json

filter_uncategorized?Filter Uncategorized
account_ids?array<string>|null
merchant_ids?array<string>|null
category_ids?array<string>|null
amount_filter?|null
penny_detailed_categories?array<>|null
name_conditions?array<>|null
set_category_id?string|null
set_merchant_id?string|null
apply_tag_ids?array<string>|null
set_hidden?Set Hidden
set_needs_review?boolean|null
apply_to_existing?Apply To Existing

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/households/string/rules/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "Rl9cF3nV7sQa",  "priority": 1,  "account_ids": [    "Ac7kP2mN9qRs"  ],  "merchant_ids": [    "Mr9dL3xT6bQa"  ],  "category_ids": [    "Ct5nR8wY1jFu"  ],  "amount_filter": {    "currency": "USD",    "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}

Get Rule GET

Retrieves an active household rule with its priority, matching conditions, and actions. Returns rulenotfound if the rule is deleted or does not belong to…

Delete Rule DELETE

Deletes a household rule so it is no longer applied to transactions. Changes previously made by the rule, including assigned categories and tags, are…