Update Metadata

Available in version 0.8.2 and later.

With the Update Metadata endpoint, you can modify existing metadata or add new metadata to ledgers, transactions, identities, and balances after they have been created.

Important to note:When you update the metadata of a parent resource, the changes propagate to its children. For example, if you update the metadata of an inflight transaction, it is also updated on its applied or void child transactions.

How it works

Initial metadata

Consider the following metadata attached to an item:

{
  ...
  "meta_data": {
    "first_name": "Jason"
  }
}

Adding more metadata

To add a last name and verification status, send a POST request to:

curl -X POST "http://localhost:5001/{id}/metadata" \
  -H "X-Blnk-Key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "meta_data": {
      "last_name": "Brooks",
      "verification_status": "Pending"
    }
  }'

const response = await blnk.Metadata.update(
  '{id}',
  {
    meta_data: {
      last_name: 'Brooks',
      verification_status: 'Pending',
    },
  },
);

meta, resp, err := client.Metadata.UpdateMetadata(
  "{id}",
  blnkgo.UpdateMetaDataRequest{
    MetaData: blnkgo.MetaData{
      "last_name":            "Brooks",
      "verification_status": "Pending",
    },
  },
)

response = blnk.metadata.update(
  "{id}",
  {
    "meta_data": {
      "last_name": "Brooks",
      "verification_status": "Pending",
    },
  },
)

ApiResponse<JsonNode> response = blnk.metadata().update(
    "{id}",
    UpdateMetadataData.create()
        .metaData(Map.of(
            "last_name", "Brooks",
            "verification_status", "Pending"
        )));

Response

{
  "meta_data": {
    "first_name": "Jason",
    "last_name": "Brooks",
    "verification_status": "Pending"
  }
}

Updating metadata

To update the verification status, send the following request:

curl -X POST "http://localhost:5001/{id}/metadata" \
  -H "X-Blnk-Key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "meta_data": {
      "verification_status": "Approved"
    }
  }'

const response = await blnk.Metadata.update(
  '{id}',
  {
    meta_data: {
      verification_status: 'Approved',
    },
  },
);

meta, resp, err := client.Metadata.UpdateMetadata(
  "{id}",
  blnkgo.UpdateMetaDataRequest{
    MetaData: blnkgo.MetaData{
      "verification_status": "Approved",
    },
  },
)

response = blnk.metadata.update(
  "{id}",
  {
    "meta_data": {
      "verification_status": "Approved",
    },
  },
)

ApiResponse<JsonNode> response = blnk.metadata().update(
    "{id}",
    UpdateMetadataData.create()
        .metaData(Map.of("verification_status", "Approved")));

Response

{
  "meta_data": {
    "first_name": "Jason",
    "last_name": "Brooks",
    "verification_status": "Approved"
  }
}

Breaking change (0.14.0+): The Update Metadata response now returns meta_data instead of metadata.If you parse the response by key, use meta_data or support both for compatibility. See the 0.14.0 migration guide for details.

Final metadata

After these updates, the metadata for the item will look like this:

{
  ...
  "meta_data": {
    "first_name": "Jason",
    "last_name": "Brooks",
    "verification_status": "Approved"
  }
}

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.

Create Metadata

Search via Database Filtering

Start Here

Ledgers

Ledger balances

Transactions

Reconciliation

Identities

Metadata

Search

Webhooks

API keys

Guides

Configuration

Advanced

Migration guides

How it works

Initial metadata

Adding more metadata

Updating metadata

Final metadata

Need help?

​How it works

Initial metadata

Adding more metadata

Updating metadata

Final metadata

​Need help?

How it works

Need help?