Penny Docs
Merchants

Update Merchant

PUT
/v1/households/{household_id}/merchants/{merchant_id}

Replaces a merchant's name and website and returns the updated merchant. Changes are reflected wherever that merchant is displayed in the household.

Supply both fields. Use website: null to clear the website. The name must remain unique among active household merchants.

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
merchant_id*Merchant Id

Request Body

application/json

name*Name
Lengthlength <= 255
website?|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/households/string/merchants/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Blue Bottle Coffee"  }'
{  "id": "Mr9dL3xT6bQa",  "name": "Blue Bottle Coffee",  "website": "https://www.bluebottlecoffee.com/",  "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png",  "default_image_url": "https://cdn.penny.finance/merchants/default-coffee.png",  "transaction_count": 18,  "recurring_transaction_count": 1}

Delete Merchant DELETE

Deletes a merchant and clears its assignment from all associated transactions, including transactions on deleted accounts. The transactions themselves are…

Delete Merchant Image DELETE

Removes a merchant's custom image so imageurl falls back to defaultimageurl, which may be null. Returns 204 with no response body on success, or noimage if…