Update a budget's details

Updates the details of a given budget.

SecurityCommonAuth
Request
path Parameters
budgetId
required
string <uuid> <= 36 characters

The ID of the budget to work with.

Example: 775596ae-2624-40af-a9dc-9756110a4a03
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

object

Details about the feature(s) to enable for the budget.

allowCurrencyAlignment
boolean

Whether or not currency alignment is enabled for the budget. Currency alignment allows a cardholder to pay in a currency that is different from the budget's currency, with Equals Money doing the conversion.

lowBalanceAlertEnabled
boolean

Whether or not the low balance alert is enabled for the budget.

name
string <= 75 characters

The budget name

Responses
200

OK

patch/budgets/{budgetId}
Request samples
application/json
{
  • "feature": {
    },
  • "allowCurrencyAlignment": false,
  • "lowBalanceAlertEnabled": false,
  • "name": "Test Budget"
}
Response samples
application/json
{
  • "id": "775596ae-2624-40af-a9dc-9756110a4a03",
  • "boxId": "a43231c221",
  • "name": "Team Party",
  • "accountId": "F50091",
  • "parentId": "775596ae-2624-40af-a9dc-9756110a4a03",
  • "feature": [
    ],
  • "currency": [
    ],
  • "balance": [
    ],
  • "totalBalance": [
    ],
  • "children": [
    ],
  • "details": [
    ],
  • "settlementDetails": {
    },
  • "individualBudgetHolder": {
    },
  • "priority": 1,
  • "level": 1,
  • "type": "accountBalance",
  • "status": "active",
  • "allowCurrencyAlignment": true,
  • "lowBalanceAlertEnabled": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}