Skip to main content
PATCH
Update a budget plan

Authorizations

Authorization
string
header
required

A Finta API key from API settings, or an OAuth access token issued to an authorized app. Send either as Authorization: Bearer <token>.

Path Parameters

id
string
required

Plan id or name

Required string length: 1 - 100

Body

application/json
name
string
Required string length: 1 - 100
accountIds
string<uuid>[] | null

Accounts the plan covers, or null for every account

Minimum array length: 1
isDefault
enum<boolean>

Make this the default plan. The previous default loses the flag.

Available options:
true
method
enum<string>

standard compares spending to a monthly plan. envelope plans only what the user assigns from Ready to Assign.

Available options:
standard,
envelope

Response

Updated plan and the fields that changed

plan
object
required
fieldsChanged
string[]
required