Skip to main content
PUT
/
api
/
ledger
/
v2
/
{ledger}
/
metadata
Update ledger metadata
curl --request PUT \
  --url http://localhost/api/ledger/v2/{ledger}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "admin": "true"
}
'
{
  "errorCode": "VALIDATION",
  "errorMessage": "[VALIDATION] invalid 'cursor' query param",
  "details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9"
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Update the metadata attached to a ledger. Use for storing environment labels, owner information, or configuration flags.

​
Request Body

Metadata key-value pairs to set on the ledger.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
ledger
string
required

Name of the ledger.

Example:

"ledger001"

Body

application/json
​
{key}
string

Response

OK