Skip to main content
PUT
/
ledgers
/
{id}
Update ledger name
curl --request PUT \
  --url http://localhost:5001/ledgers/{id} \
  --header 'X-blnk-key: <api-key>'
Use blnk.Ledgers.update to edit the name of a specific ledger.
To update your ledger metadata, use blnk.Metadata.update instead.
blnk.Ledgers.update
const response = await blnk.Ledgers.update(
  'ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb',
  {
    name: 'Updated Customer Savings Ledger',
  },
);
FieldTypeDescription
idstringLedger ID to update.
namestringNew display name for the ledger.

​
Response shape

200 OK
{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "Updated Customer Savings Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "project_owner": "Acme LLC",
    "description": "For all savings account created & managed by Acme."
  }
}
FieldDescription
ledger_idUnique ID for the ledger. Unchanged after the update.
nameUpdated name you passed in the request.
created_atDate and time the ledger was created.
meta_dataExisting metadata on the ledger. Not modified by this method.

View ledger docs

Ledger concepts and setup.

Update ledger name

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.