FOformancehq
Accounts

Save account metadata

Changed on

Saves metadata for a specific account in the ledger. Requires ledger:WriteMetadata scope (included in the default ledger:write mapping).

post/v3/{ledgerName}/accounts/{address}/metadata

Request

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

Path parameters

ledgerNamestring required

Name of the ledger

addressstring required
Example:users:001

Raw account address, for example users:001. Direct HTTP clients may URL-encode it as one path segment (users%3A001). Decoded exactly once.

Headers

Idempotency-Keystring

Idempotency key for the request

Request body

object required

Metadata key-value pairs (supports typed values)

Example request

{
  "account_type": "asset",
  "label": "Bank Account",
  "active": true,
  "balance_threshold": 1000
}

Response

Account metadata saved successfully

Changes

  • f5e817eca038Revision changes
    • info

      api operation id saveAccountMetadata removed and replaced with v3SaveAccountMetadata

  • 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