API Reference
Postman collections ↗Bud Console ↗

Update Savings Goal V2

patch
https://api-sandbox.thisisbud.com/goals/v2/savings/goals/

Update a savings goal with the given savings_goal_id. All fields are optional.

The goal_balance returned in the response is recalculated as the current account balance multiplied by the updated allocation_ratio.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The ID of the savings goal.

Example: 81a68821-dca6-4771-80d4-002c7fce412e

Body Params
string

The account ID the savings goal is associated with.

Example: RxsYshVGded4JeilkXgWKdXA

string

The name of the savings goal.

Example: Holiday

target_amount
object

The target amount of money to be saved for this goal.

string | null

The target date by which the savings goal should be reached, in the format RFC-3339. Must be a future date. Set to null to remove the target date.

Examples:

  • 2025-12-31T00:00:00Z
  • 2025-12-31T00:00:00+01:00
float

The proportion of the account balance to allocate to this savings goal. Must be greater than 0 and at most 1.

Example: 0.25

Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

A unique identifier for a Customer, as registered on Bud's platform.

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

Responses

Updated 16 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 16 days ago