Skip to main content
PATCH
Update Account

Authorizations

Authorization
string
header
required

API key prefixed with sk_.

Path Parameters

id
string
required

The ID of the Account.

Body

application/json
name
string

Update the display name for the Account.

metadata
object | null

Replace the metadata attached to the Account. Set to null to clear.

Response

Updated Account.

id
string
Example:

"acc_01JA1B2C3D4E5F6G7H8J9K0L"

entityId
string
Example:

"ent_01JA1B2C3D4E5F6G7H8J9K0L"

name
string
Example:

"Treasury"

type
enum<string>
Available options:
wallet,
bank
Example:

"wallet"

chain
string | null
Example:

"base"

availableBalance
string
Example:

"1000000"

pendingBalance
string
Example:

"0"

lockedBalance
string
Example:

"0"

holdingBalance
string
Example:

"0"

currency
string
Example:

"USDC"

status
enum<string>
Available options:
active,
inactive
Example:

"active"

autoEarn
boolean

Whether this Account is earning yield on idle balances.

Example:

true

metadata
object | null
createdAt
string<date-time>
Example:

"2025-01-15T12:00:00Z"

updatedAt
string<date-time>
Example:

"2025-01-15T12:00:00Z"