Ledgers

Update ledger name

Update the name of an existing ledger.

PUT/ledgers/{ledger_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

ledger_idstringrequiredpath

Unique ledger_id of the ledger whose name you want to update.

Body

namestringrequiredbody

The new name for the ledger. Ensure it is descriptive and meaningful for easy reference.

curl -X PUT "http://localhost:5001/ledgers/{ledger_id}" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Customer Savings Ledger"
  }'

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

{
  "error": "Ledger not found",
  "error_detail": {
    "code": "LGR_NOT_FOUND",
    "message": "Ledger not found"
  }
}