update_account

Updates one account by accountId for the authenticated user. Wraps the updateAccount RPC.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
Preview the prompt that will be copied

Access

  • Effect: Changes data
  • Required scope: write (the mcp scope also grants it)

Example request

The JSON-RPC message an MCP client sends to call this tool. Your client builds it for you; this is for reference and debugging in a tool such as MCP Inspector.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_account",
    "arguments": {
      "account": {}
    }
  }
}

Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.

Description

Updates one account by accountId for the authenticated user. Wraps the updateAccount RPC.

Get accountId from list_accounts, read_account, or create_account.
If accountId is unknown, pass accountName (current name or hint like "checking") to resolve it automatically.
If several accounts match the hint, this asks which one — do not guess.
For risky credit limits (far above income, or very large), pass naturalLanguageHint with the full user sentence; the tool may ask for confirmation via confirmHighCreditLimit=true.
If accountFieldMasks is omitted, masks are inferred from the provided account fields.
After updating, confirm in plain language.

Input parameters

NameTypeRequiredDescription
accountobjectYes
accountFieldMasksarrayNo
accountIdstringNo
accountNamestringNo
confirmHighCreditLimitbooleanNo
naturalLanguageHintstringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "account": {
      "additionalProperties": false,
      "properties": {
        "accountIconPreference": {
          "type": [
            "null",
            "string"
          ]
        },
        "accountSubtype": {
          "type": [
            "null",
            "string"
          ]
        },
        "accountType": {
          "type": [
            "null",
            "string"
          ]
        },
        "appleCardIntegration": {
          "additionalProperties": false,
          "properties": {
            "appleCardAccountId": {
              "type": "string"
            },
            "lastSyncedAt": {
              "type": [
                "null",
                "string"
              ]
            }
          },
          "required": [
            "appleCardAccountId"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "assetSale": {
          "additionalProperties": false,
          "properties": {
            "saleDate": {
              "type": "string"
            },
            "salePriceCents": {
              "type": [
                "null",
                "integer"
              ]
            },
            "sellingCostsCents": {
              "type": [
                "null",
                "integer"
              ]
            },
            "status": {
              "type": "string"
            }
          },
          "required": [
            "status",
            "saleDate"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "assetType": {
          "type": [
            "null",
            "string"
          ]
        },
        "countryId": {
          "type": [
            "null",
            "integer"
          ]
        },
        "creditLimit": {
          "type": [
            "null",
            "number"
          ]
        },
        "customIcon": {
          "type": [
            "null",
            "string"
          ]
        },
        "customIconColor": {
          "type": [
            "null",
            "string"
          ]
        },
        "customImageFileId": {
          "type": [
            "null",
            "string"
          ]
        },
        "debtInterestRate": {
          "type": [
            "null",
            "number"
          ]
        },
        "defaultCurrency": {
          "type": [
            "null",
            "string"
          ]
        },
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "fuelEfficiency": {
          "type": [
            "null",
            "number"
          ]
        },
        "giftCardVendorId": {
          "type": [
            "null",
            "string"
          ]
        },
        "giftCardVendorName": {
          "type": [
            "null",
            "string"
          ]
        },
        "governmentAccountType": {
          "type": [
            "null",
            "string"
          ]
        },
        "gracePeriod": {
          "type": [
            "null",
            "string"
          ]
        },
        "interestRecurrenceRate": {
          "type": [
            "null",
            "string"
          ]
        },
        "investmentType": {
          "type": [
            "null",
            "string"
          ]
        },
        "isVariableInterestRate": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "positionOrder": {
          "type": [
            "null",
            "integer"
          ]
        },
        "savingInterestRate": {
          "type": [
            "null",
            "number"
          ]
        },
        "stockPrice": {
          "type": [
            "null",
            "number"
          ]
        },
        "stockQuantity": {
          "type": [
            "null",
            "number"
          ]
        },
        "stockSymbol": {
          "type": [
            "null",
            "string"
          ]
        },
        "transactionSyncNotificationSettings": {
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            }
          },
          "required": [
            "enabled"
          ],
          "type": [
            "null",
            "object"
          ]
        }
      },
      "type": "object"
    },
    "accountFieldMasks": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "path": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ],
        "type": "object"
      },
      "type": [
        "null",
        "array"
      ]
    },
    "accountId": {
      "type": "string"
    },
    "accountName": {
      "type": [
        "null",
        "string"
      ]
    },
    "confirmHighCreditLimit": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "naturalLanguageHint": {
      "type": [
        "null",
        "string"
      ]
    }
  },
  "required": [
    "account"
  ],
  "type": "object"
}