Patches the AccountLink on a box. Replace the linked account (source + accountId / manual create fields), edit manual balances/names, change paymentMode, and/or set alertSettings (pass null to clear). Bank/crypto snapshot balances stay sync-owned — replace accountId to change which account funds the box.
PATCH
/v1/update_accountBody
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| budgetId | string | Yes | — | Budget that owns the box. |
| boxId | string | Yes | — | Box whose AccountLink to patch. |
| source | string | No | — | When replacing: manual, bank, or crypto. |
| accountId | string | No | — | Replace payment account id for this source (manual id or snapshot id). |
| creditAccountId | string | No | — | Replace bank credit snapshot (with accountId as payment). |
| name | string | No | — | Manual: new payment display name, or create fields when replacing with source manual. |
| currency | string | No | — | Manual: payment currency. |
| balance | number | No | — | Manual: new payment balance (does not create a transaction). |
| accountKind | string | No | — | Manual: payment kind. |
| paymentMode | string | No | — | account or creditCard. |
| creditName | string | No | — | Manual: credit account display name. |
| creditCurrency | string | No | — | Manual: credit account currency. |
| creditBalance | number | No | — | Manual: credit account balance. |
| creditCycleEndDay | number | No | — | Credit cycle end day 1–31. |
| alertSettings | object | No | — | Set alert rules (see alertSettings below), or null to clear all alerts. |
alertSettings
Optional object of box account alerts (same rules as in-app Accounts setup). Omit to leave alerts unset on link_account. On update_account, pass null to clear all alerts. Only rules with enabled: true are stored; disabled-only objects are dropped.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| balanceThreshold | object | No | — | Fire when the funding balance crosses a threshold. |
| balanceThreshold.enabled | boolean | No | false | Turn the threshold alert on. |
| balanceThreshold.amount | number | Conditional | — | Threshold amount in the account currency (required when enabled). |
| balanceThreshold.direction | string | No | below | below (balance drops under amount) or above (balance rises over amount). |
| insufficientForPlan | object | No | — | Fire when the funding balance cannot cover upcoming planned expenses in the box. |
| insufficientForPlan.enabled | boolean | No | false | Turn the insufficient-for-plan alert on. |
| creditExceedsPayment | object | No | — | Credit-card links only: fire when the card balance exceeds the linked payment account balance. |
| creditExceedsPayment.enabled | boolean | No | false | Turn the credit-exceeds-payment alert on. |
Response data
| Field | Type | Description |
|---|---|---|
| budgetId | string | Id of the budget this resource belongs to. |
| boxId | string | Id of the parent expense box. |
| accountLinkId | string | AccountLink id on the box. |
| source | string | manual, bank, or crypto after the update. |
| updated | boolean | True on patch-only success. |
| alertSettings | object | Present when alertSettings was sent (same shape as request). |