---
title: "Update sub-account details by sub-account ID."
method: PUT
path: "/ledger/subaccounts/{subAccountIdRef}"
tags: ["ledger-sub-accounts"]
---

# Update sub-account details by sub-account ID.

`PUT /ledger/subaccounts/{subAccountIdRef}`

This endpoint updates sub-account details by sub-account ID.

## Path parameters

- `subAccountIdRef` string, required

## Request body

- UpdateSubAccountRequest
  - `displayName` string — An optional name for the sub-account.
  - `frozen` boolean, required — Indicates if the sub-account is frozen (locked) or not.

## Response `200`

Sub-account updated Successfully

- SubAccount
  - `id` string, uuid, required — Unique sub-account ID
  - `accountId` string, uuid, required — The main account ID to which this sub-account belongs.
  - `displayName` string — An optional name for the sub-account.
  - `reference` string, required — A unique reference for the sub-account.
  - `currency` string, required — Currency of the sub-account
  - `accountBalance` AccountBalanceDetails, required — Account balance details
    - `balance` number — The actual ledger balance of the account
    - `availableBalance` number — The available balance for spending
  - `frozen` boolean, required — Indicates if the sub-account is frozen (locked) or not.
  - `createdDate` string, date-time, required — The date the sub-account was created.

## Other responses

- `400` — Request could not be validated
- `401` — Client is not authorized to make request
- `403` — Expected permission is not available.
- `404` — Entity was not found
- `default` — Internal Server Error

## Changes

- **2026-07-26** `a3c4e2742615` — 2 info
  - the endpoint scheme security `HMACAuth` was added to the API
  - the endpoint scheme security `authToken` was removed from the API

[Change history](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/changes/ledger/subaccounts/:subAccountIdRef/put.md)

---

[API](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway.md) · [All operations](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nestechops/onboard-external-api-gateway/revisions/76329919f8a7/schema)
