API Reference
Postman collections ↗Bud Console ↗

Create Savings Goal V2

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

Create a savings goal for the given account.

The allocation_ratio defines the proportion of the account balance that is considered allocated to this goal. For example, an allocation_ratio of 0.2 means that 20% of the account balance is treated as the goal balance.

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

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

The account ID the savings goal is associated with.

Example: RxsYshVGded4JeilkXgWKdXA

string
required

The name of the savings goal.

Example: Holiday

target_amount
object
required

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

string

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

Examples:

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

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

Example: 0.2

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