Delete metadata by key

Delete metadata by key

DELETE /api/ledger/v2/{ledger}/accounts/{address}/metadata/{key}

Delete metadata by key

cURL

curl --request DELETE \
  --url http://localhost/api/ledger/v2/{ledger}/accounts/{address}/metadata/{key} \
  --header 'Authorization: Bearer <token>'

2XX

This response has no body data.

Remove a specific metadata key from an account.

Parameters

ledger: The name of the ledger containing the account. (e.g., ledger001)

address: The account address to delete metadata from. (e.g., users:john:wallet)

key: The metadata key to delete. (e.g., account_type)

Idempotency-Key: Unique key to ensure the request is processed exactly once. (e.g., del-meta-abc123)

Authorizations

Authorization · string · header · required

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

Headers

Idempotency-Key · string

Use an idempotency key

Path Parameters

ledger · string · required

Name of the ledger.

Example:

"ledger001"

address · string · required

Account address

key · string · required

The key to remove.

Example:

"foo"

Response

2XX