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>'
import requests

url = "http://localhost:5001/ledgers/{id}"

headers = {"X-blnk-key": "<api-key>"}

response = requests.put(url, headers=headers)

print(response.text)
const options = {method: 'PUT', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/ledgers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5001",
  CURLOPT_URL => "http://localhost:5001/ledgers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "X-blnk-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5001/ledgers/{id}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("X-blnk-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("http://localhost:5001/ledgers/{id}")
  .header("X-blnk-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/ledgers/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.Ledgers.update to edit the name of a specific ledger.
To update your ledger metadata, use blnk.Metadata.update instead.
1

Call the method

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.
2

Confirm the update

The ledger_id in the response stays the same. Verify response.data.name matches the name you passed in the request.
3

Response

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."
  }
}
FieldTypeDescription
ledger_idstringUnique ID for the ledger. Unchanged after the update.
namestringUpdated name you passed in the request.
created_atstringDate and time the ledger was created.
meta_dataRecord<string, unknown>Existing 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.