Penny Docs
Tags

Patch Tag

PATCH
/v1/households/{household_id}/tags/{tag_id}

Changes only a tag's supplied name or color. Omitted fields retain their latest values, read under a database lock. Null clears color; name cannot be null. Transaction assignments and rule references are retained.

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
tag_id*Tag Id

Request Body

application/json

name?Name
Length1 <= length <= 255
color?|null

Response Body

application/json

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/tags/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "Tg8qN1cK5rWd",  "name": "Work meals",  "color": "#6D5BD0",  "transaction_count": 12}

Get Tag GET

Retrieves an active household tag, including its color and visible transaction count. Returns tagnotfound if the tag is deleted or does not belong to this…

Delete Tag DELETE

Deletes a tag and removes it from every associated transaction, including transactions on deleted accounts. The transactions themselves are retained. Also…