Ledgers
Update a ledger
Updates a ledger. Cannot update system ledgers.
PATCH
/
ledgers
/
{ledger_id}
Update a ledger
curl --request PATCH \
--url https://app.gomangrove.com/api/v1/ledgers/{ledger_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ledger": {
"name": "Updated Ledger Name"
}
}
'import requests
url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}"
payload = { "ledger": { "name": "Updated Ledger Name" } }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ledger: {name: 'Updated Ledger Name'}})
};
fetch('https://app.gomangrove.com/api/v1/ledgers/{ledger_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_URL => "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'ledger' => [
'name' => 'Updated Ledger Name'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}"
payload := strings.NewReader("{\n \"ledger\": {\n \"name\": \"Updated Ledger Name\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ledger\": {\n \"name\": \"Updated Ledger Name\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ledger\": {\n \"name\": \"Updated Ledger Name\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "lgr_abc123def456",
"name": "Updated Ledger Name",
"unit": "t",
"system_ledger_type": null,
"partition_type": "time",
"cadence": "monthly",
"latest_model": {
"id": "mdl_abc123def456",
"name": "Carbon Calculation Model"
},
"asset_category": null,
"created_at": "2025-01-15T10:00:00.000Z",
"updated_at": "2025-01-15T12:00:00.000Z"
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Cannot modify system ledger"
}
]
}Previous
Delete a ledgerDeletes a ledger. Cannot delete system ledgers or ledgers with batches/model runs.
Next
⌘I
Update a ledger
curl --request PATCH \
--url https://app.gomangrove.com/api/v1/ledgers/{ledger_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ledger": {
"name": "Updated Ledger Name"
}
}
'import requests
url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}"
payload = { "ledger": { "name": "Updated Ledger Name" } }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ledger: {name: 'Updated Ledger Name'}})
};
fetch('https://app.gomangrove.com/api/v1/ledgers/{ledger_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_URL => "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'ledger' => [
'name' => 'Updated Ledger Name'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}"
payload := strings.NewReader("{\n \"ledger\": {\n \"name\": \"Updated Ledger Name\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ledger\": {\n \"name\": \"Updated Ledger Name\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ledger\": {\n \"name\": \"Updated Ledger Name\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "lgr_abc123def456",
"name": "Updated Ledger Name",
"unit": "t",
"system_ledger_type": null,
"partition_type": "time",
"cadence": "monthly",
"latest_model": {
"id": "mdl_abc123def456",
"name": "Carbon Calculation Model"
},
"asset_category": null,
"created_at": "2025-01-15T10:00:00.000Z",
"updated_at": "2025-01-15T12:00:00.000Z"
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Cannot modify system ledger"
}
]
}