personal finance

Update a goal

put/personal-finance/goals/{id}

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/personal-finance/goals/{id}
  • Auth: bearer (a scheme the document does not define)

Path parameters

idstring required

Request body

namestring

Goal name

descriptionstring

Goal description

targetAmountnumber

Target amount

currencystring

Currency for this goal (only contributions in this currency count)

currentAmountnumber

Current amount saved (defaults to 0)

deadlinestring

Deadline (YYYY-MM-DD)

colorstring

Color hex code

iconstring

Icon name (Lucide icon)

isActiveboolean

Whether the goal is active

Example request

{
  "name": "New Laptop",
  "description": "Saving for a MacBook Pro",
  "targetAmount": 2500,
  "currency": "USD",
  "currentAmount": 500,
  "deadline": "2024-12-31",
  "color": "#3b82f6",
  "icon": "Laptop"
}

Response

Goal updated

Changes

No recorded changes to this operation across all 1 revision of this API.