Skip to main content
PUT
/
ledgers
/
:id
curl -X PUT https://YOUR_BLNK_INSTANCE_URL/ledgers/ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f \
  -H 'Content-Type: application/json' \
  -H 'X-Blnk-Key: YOUR_API_KEY' \
  -d '{
    "name": "Updated Customer Wallets"
  }'

{
  "ledger_id": "ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f",
  "name": "Updated Customer Wallets",
  "created_at": "2024-01-15T10:30:00Z",
  "meta_data": {
    "region": "US",
    "project_id": "proj_123"
  }
}
Update the name of an existing ledger. Currently, only the ledger name can be updated.

​
Path Parameters

​
id
string
required
The unique identifier of the ledger to update

​
Request Body

​
name
string
required
The new name for the ledger. This field is required and cannot be empty.

​
Response

​
ledger_id
string
Unique identifier for the ledger
​
name
string
The updated name of the ledger
​
created_at
string
ISO 8601 timestamp of when the ledger was created
​
meta_data
object
Custom metadata associated with the ledger
curl -X PUT https://YOUR_BLNK_INSTANCE_URL/ledgers/ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f \
  -H 'Content-Type: application/json' \
  -H 'X-Blnk-Key: YOUR_API_KEY' \
  -d '{
    "name": "Updated Customer Wallets"
  }'

{
  "ledger_id": "ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f",
  "name": "Updated Customer Wallets",
  "created_at": "2024-01-15T10:30:00Z",
  "meta_data": {
    "region": "US",
    "project_id": "proj_123"
  }
}

​
Usage Notes

  • The ledger ID must be provided in the URL path
  • The name field is required and must not be empty
  • Only the ledger name can be updated; meta_data and other fields are immutable after creation
  • The created_at timestamp remains unchanged after updates
  • Updating a ledger name does not affect existing balances or accounts associated with it
  • Use descriptive names that clearly identify the purpose of the ledger

Build docs developers (and LLMs) love

Get started for freeTalk to us