Ledgers
Update ledger name
Update the name of an existing ledger.
PUT
/
ledgers
/
{id}
curl -X PUT "http://localhost:5001/ledgers/{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"
}
}
If you’re using the auto-provisioned
Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.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.
See also: Scoped API keys and Secure your Blnk server.
Path
string
required
Unique
ledger_id of the ledger whose name you want to update.Body
string
required
The new name for the ledger. Ensure it is descriptive and meaningful for easy reference.
curl -X PUT "http://localhost:5001/ledgers/{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"
}
}
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.Was this page helpful?
⌘I
curl -X PUT "http://localhost:5001/ledgers/{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"
}
}