Skip to main content
PATCH
/
v1
/
accounts
/
{account_id}
Update Account
curl --request PATCH \
  --url https://api.example.com/v1/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "metadata": {}
}
'
{
  "accountId": "<string>",
  "name": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.bluerails.com/llms.txt

Use this file to discover all available pages before exploring further.

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

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
read-only

Unique identifier for the account

​
name
string
required

Display name for the account

​
purpose
enum<string>
required

The purpose of the account

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

Classification that determines the account's priority and usage patterns

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

Current operational status of the account

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

Timestamp when the account was created

​
createdAt
string<date-time>
required
read-only

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