> ## Documentation Index
> Fetch the complete documentation index at: https://learn.breezing.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Wallet API

> Update a Breezing wallet's name, folder, Sync all exclusion, GL account mapping, or linked contacts without changing its address or chain.



## OpenAPI

````yaml PATCH /wallets/{id}
openapi: 3.1.0
info:
  title: Breezing Public API
  version: 1.0.0
  description: >-
    Crypto accounting API for programmatic access and AI agents. Authenticate
    with an API key using the Authorization header: `Bearer brz_...`
servers:
  - url: https://api.breezing.io/v1
security:
  - BearerAuth: []
paths:
  /wallets/{id}:
    patch:
      tags:
        - Wallets
      summary: Update a wallet
      description: >-
        Partial update (only provided fields change): the display name, the
        wallet folder (`folderId`, the dashboard sidebar grouping; null removes
        the wallet from its folder, a folder of another company is a 400), the
        Sync all exclusion (`disablePullLatestTrx`: true excludes the wallet
        from the dashboard Sync all while explicit POST /wallets/{id}/sync calls
        still work), the Wallet GL Accounts mapping and the Wallet Linked
        Contacts. The address, chain, exchange credentials and import settings
        cannot be changed here. `glAccounts` replaces the whole mapping and is
        accepted on exchange and bank wallets only (400 on blockchain wallets);
        every code must exist in the chart of accounts (400 otherwise, with the
        offending code in the message). A changed mapping re-stamps the wallet's
        existing unlocked rows in the changed tokens through background batch
        update tasks, the same behavior as the dashboard's Edit wallet dialog.
        `linkedContacts` replaces the whole list (exchange and bank wallets
        only, 400 otherwise): the contacts this wallet is known by on other
        wallets, for example the bank label a Stripe payout names or an exchange
        deposit address; a transaction on another wallet to or from one of them
        is matched automatically as an internal transfer with this wallet's
        opposite leg (same currency and amount within a few days), and a changed
        list re-runs that matcher over the existing rows. Credentials and sync
        settings are dashboard only.
      parameters:
        - schema:
            type: string
            description: Wallet ID
            example: '1'
          required: true
          description: Wallet ID
          name: id
          in: path
        - schema:
            type: string
            description: >-
              Organization ID. Use GET /v1/companies to discover available
              org/company pairs.
            example: '1'
          required: true
          description: >-
            Organization ID. Use GET /v1/companies to discover available
            org/company pairs.
          name: orgId
          in: query
        - schema:
            type: string
            description: >-
              Company ID. Use GET /v1/companies to discover available companies
              and their access levels.
            example: '1'
          required: true
          description: >-
            Company ID. Use GET /v1/companies to discover available companies
            and their access levels.
          name: companyId
          in: query
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWalletBody'
      responses:
        '200':
          description: >-
            Wallet updated; returns the updated wallet, plus updated: 1 (the
            response before the route returned the wallet)
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      id:
                        type: number
                        description: Wallet ID
                      name:
                        type: string
                        description: Wallet name
                      orgId:
                        type: number
                        description: Organization ID
                      companyId:
                        type: number
                        description: Company ID
                      address:
                        type: string
                        nullable: true
                        description: Wallet address
                      exchange:
                        type: string
                        nullable: true
                        description: Exchange name (e.g. binance, kraken)
                      bankAccount:
                        type: string
                        nullable: true
                        description: Bank account identifier (legacy, unused)
                      glAccounts:
                        type: array
                        items:
                          type: object
                          properties:
                            token:
                              type: string
                              description: Token symbol, e.g. EUR
                            code:
                              type: string
                              description: Chart of accounts code for that token
                          required:
                            - token
                            - code
                        description: >-
                          Wallet GL Accounts: the GL account each token of this
                          exchange or bank wallet posts to. Imported rows in a
                          mapped token carry that code as their asset account.
                          Empty for chain wallets and for wallets without a
                          mapping.
                      linkedContacts:
                        type: array
                        items:
                          type: string
                        description: >-
                          Wallet Linked Contacts: the contact addresses or
                          labels this exchange or bank wallet is known by on
                          other wallets (a bank label a Stripe payout names, an
                          exchange deposit address). A transaction on another
                          wallet to or from one of them is matched automatically
                          as an internal transfer with this wallet. Empty for
                          chain wallets and unlinked wallets.
                      type:
                        type: string
                        nullable: true
                        description: Wallet type
                      chain:
                        type: string
                        nullable: true
                        description: Blockchain identifier
                        example: eth
                      status:
                        type: string
                        nullable: true
                        description: Sync status
                      dataFrom:
                        type: string
                        nullable: true
                        description: Data source identifier
                      dateFrom:
                        type: string
                        nullable: true
                        description: Sync start date
                      dateTo:
                        type: string
                        nullable: true
                        description: Sync end date
                      addedTransactions:
                        type: number
                        nullable: true
                        description: Number of synced transactions
                      folderId:
                        type: number
                        nullable: true
                        description: Folder ID for organization
                      disablePullLatestTrx:
                        type: boolean
                        description: Whether auto-sync is disabled
                      createdAt:
                        type: number
                        description: Created timestamp (unix ms)
                      updatedAt:
                        type: number
                        description: Updated timestamp (unix ms)
                      updated:
                        type: number
                        enum:
                          - 1
                    required:
                      - id
                      - name
                      - orgId
                      - companyId
                      - address
                      - exchange
                      - bankAccount
                      - glAccounts
                      - linkedContacts
                      - type
                      - chain
                      - status
                      - dataFrom
                      - dateFrom
                      - dateTo
                      - addedTransactions
                      - folderId
                      - disablePullLatestTrx
                      - createdAt
                      - updatedAt
                      - updated
                required:
                  - success
                  - data
        '400':
          description: >-
            Invalid wallet ID, no fields to update, an unknown folder, GL
            accounts on a blockchain wallet, or a code missing from the chart
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: >-
            API key has no access to this company, has read-only access where
            write was required, or the company subscription is inactive
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Wallet not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
      security:
        - BearerAuth: []
components:
  schemas:
    UpdateWalletBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
          description: New display name for the wallet (1-256 chars, trimmed).
        folderId:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
          description: >-
            Wallet folder the wallet is shown in (dashboard sidebar grouping).
            null removes it from its folder. The folder must belong to this
            company.
        disablePullLatestTrx:
          type: boolean
          description: >-
            true excludes the wallet from the dashboard Sync all; explicit syncs
            (POST /wallets/{id}/sync) still work. There is no scheduled wallet
            sync.
        glAccounts:
          type: array
          items:
            type: object
            properties:
              token:
                type: string
                minLength: 1
                maxLength: 64
                description: Token symbol as it appears on the rows, e.g. EUR
              code:
                type: string
                minLength: 1
                maxLength: 128
                description: Chart of accounts code the token posts to
            required:
              - token
              - code
          maxItems: 50
          description: >-
            Wallet GL Accounts: the FULL mapping to store (one entry per token;
            an empty array removes every mapping). Exchange and bank wallets
            only. Every code must exist in the chart of accounts. Rows imported
            later in a mapped token carry the code as their asset account; on a
            change, the wallet's existing unlocked rows in the changed tokens
            are re-stamped through background tasks (rows whose asset account
            was set by hand are left alone).
        linkedContacts:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 256
          maxItems: 100
          description: >-
            Wallet Linked Contacts: the FULL list of contact addresses or labels
            this wallet is known by on other wallets (an empty array removes the
            list). Exchange and bank wallets only. Entries are trimmed and must
            be unique ignoring case. A changed list re-runs the internal matcher
            over the existing rows right away (a processInternalTrx task).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.