Skip to main content
PATCH
/
v1
/
accounts
/
{account_id}
{
  "accountId": "acc_12345",
  "name": "Primary Business Account",
  "description": "Main account for business operations",
  "purpose": "OPERATING",
  "classification": "PRIMARY",
  "status": "ACTIVE",
  "metadata": {
    "department": "finance",
    "costCenter": "HQ"
  },
  "updatedAt": "2025-04-29T13:29:15.064Z",
  "createdAt": "2025-04-29T13:29:15.064Z"
}

Path Parameters

​
account_id
string
required

The unique identifier of the account to update, starts with acct_

Body

application/json

Input properties for updating an existing account

​
name
string

New display name for the account

​
description
string

New description of the account's purpose

​
classification
enum<string>

New classification for the account Allowed classifications for an account Determines the account's priority and usage patterns

Available options:
PRIMARY,
SECONDARY
​
metadata
object

Updated custom data associated with the account

Response

The request has succeeded.

Represents a financial account in the system Accounts are used to track balances and process transactions

​
accountId
string
required

Unique identifier for the account

​
name
string
required

Display name for the account

​
purpose
enum<string>
required

The purpose of the account Defines the primary purpose or category assigned by an SME to an account, facilitating the organization and management of funds within their treasury operations. From the perspective of Bluerails (the treasury solution provider), all these accounts represent liabilities.

Available options:
OPERATING,
WALLET,
REVENUE,
TAX,
RESERVE,
OTHER
​
classification
enum<string>
required

Classification that determines the account's priority and usage patterns Allowed classifications for an account Determines the account's priority and usage patterns

Available options:
PRIMARY,
SECONDARY
​
status
enum<string>
required

Current operational status of the account The status of the account Indicates whether the account can be used for transactions

Available options:
ACTIVE,
INACTIVE
​
updatedAt
string<date-time>
required

Timestamp when the account was created

​
createdAt
string<date-time>
required

Timestamp when the account was last updated

​
description
string

Detailed description of the account's purpose

​
metadata
object

Additional custom data associated with the account

⌘I