Search & metadata

Update metadata

Add or change metadata on a ledger, transaction, identity, or balance.

POST/{id}/metadata

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

idstringrequiredpath

The unique identifier of the ledger, transaction, identity, or balance whose metadata you want to update.

Body

meta_dataobjectbody

Metadata information to be added or updated.

curl -X POST "http://localhost:5001/{id}/metadata" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "meta_data": {
      "project_owner": "Acme LLC",
      "update_status": "Approved"
    }
  }'

{
  "meta_data": {
    "project_owner": "Acme LLC",
    "description": "Approved"
  }
}

{
  "error": "entity not found",
  "error_detail": {
    "code": "META_ENTITY_NOT_FOUND",
    "message": "entity not found"
  }
}

{
  "error": "unsupported entity type: zone",
  "error_detail": {
    "code": "META_UNSUPPORTED_ENTITY",
    "message": "unsupported entity type: zone"
  }
}