Skip to main content
PATCH
Update bank account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

bankAccountId
string<uuid>
required

The UUID of the bank account.

Body

application/json

Parameters for updating an existing bank account. All fields are optional; only provided fields are updated.

account_name
string | null

New display name for the bank account.

notes
string | null

New notes for the bank account.

financial_institution_name
string | null

New financial institution name.

financial_institution_id
string<uuid> | null

ID of the financial institution to associate with the bank account.

notify_when_disconnected
boolean

Whether to send a notification when any linked external account becomes disconnected.

Response

200 - application/json
data
object
required

A bank account belonging to a business. Bank accounts are the top-level container that groups one or more external accounts (connected financial accounts) under a single logical account.