MEmeow
Accounts

Update Bank Account

Updates a bank account's nickname (display name), shown in the dashboard to distinguish it from other accounts. Supported for checking accounts (grasshopper, tcb, firstbank) and crb accounts. The nickname must be unique among your accounts.

patch/accounts/{account_id}

Request

Path parameters

account_idstring required

The ID of the bank account to update.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

nicknamestring required

A custom display name for the account, shown in the dashboard to distinguish it from other accounts. 2-25 characters; letters, numbers, hyphens, apostrophes, and spaces only. Must be unique among your accounts.

Example request

{
  "nickname": "Payroll"
}

Response

Successful Response

account_idstring required

The account_id of the updated account.

nicknamestring required

The account's display name after the update.

Example response

{
  "account_id": "cash_account_3f9c1b2e-7a4d-4e88-9c21-0b6f5d8e1a2c",
  "nickname": "Payroll"
}

Changes

No recorded changes to this operation across all 1 revision of this API.