FOformancehq
Ledgers

Delete ledger metadata

Changed on

Deletes a metadata key from the ledger. Requires ledger:WriteMetadata scope (included in the default ledger:write mapping).

delete/v3/{ledgerName}/metadata/{key}

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/metadata/{key}
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

keystring required
Example:formance.com/reviewed

Raw metadata key, for example formance.com/reviewed. SDK callers pass the raw key and let the SDK encode it. Direct HTTP clients URL-encode the key as one path segment, encoding slashes as %2F. Decoded exactly once; percent characters remaining after decoding, including double-encoded slashes, are invalid metadata keys and are rejected with HTTP 400.

Headers

Idempotency-Keystring

Idempotency key for the request

Response

Ledger metadata deleted successfully

Changes

  • f5e817eca038Revision changes
    • info

      api operation id deleteLedgerMetadata removed and replaced with v3DeleteLedgerMetadata

  • 3da23d327316Revision changes
    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the non-success response with the status