Ledgers

Update ledger name

Update the name of an existing ledger with the Python SDK.

PUT/ledgers/{ledger_id}

Use blnk.ledgers.update to edit the name of a specific ledger.

Call the method

response = blnk.ledgers.update(
  "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
  {
    "name": "Updated Customer Savings Ledger",
  },
)

Field	Type	Description
`id`	`str`	Ledger ID to update.
`name`	`str`	New display name for the ledger.

Confirm the update

The ledger_id in the response stays the same. Verify response.data["name"] matches the name you passed in the request.

Response

{
  "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."
  }
}

Field	Type	Description
`ledger_id`	`str`	Unique ID for the ledger. Unchanged after the update.
`name`	`str`	Updated name you passed in the request.
`created_at`	`str`	Date and time the ledger was created.
`meta_data`	`dict`	Existing metadata on the ledger. Not modified by this method.