Penny Docs
Households

Upload Household Image

PUT
/v1/households/{household_id}/image

Uploads or replaces the household's image and returns its display URL. Only the household owner can change this image.

Send a JPEG, PNG, or WebP image in the file field of a multipart/form-data request. The limit is 5 MiB (5,242,880 bytes) and 25 million decoded pixels, including all animation frames.

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

Request Body

multipart/form-data

file*File
Formatbinary

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/households/string/image" \  -F file="string"
{  "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png"}

Delete Household Image DELETE

Removes the household's uploaded image. Only the household owner can make this change; subsequent household responses return imageurl: null. Returns 204…

Get Preferences GET

Retrieves the household's shared display preferences, including whether recurring suggestions and advanced details are shown. These settings apply to the…