> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Metadata

> Learn how to modify or add new metadata to ledgers, transactions, identities, and balances.

export const CtaCallout = props => {
  const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
  const handleCtaClick = () => {
    if (typeof window === "undefined" || !trackingEvent) {
      return;
    }
    try {
      window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
        detail: {
          name: trackingEvent,
          href
        }
      }));
    } catch {}
    try {
      window.posthog?.capture?.(trackingEvent, {
        href
      });
    } catch {}
    const gaPayload = {
      cta_href: href
    };
    try {
      window.gtag?.("event", trackingEvent, gaPayload);
    } catch {}
    try {
      window.dataLayer = window.dataLayer || [];
      window.dataLayer.push({
        event: trackingEvent,
        ...gaPayload
      });
    } catch {}
  };
  const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
  const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
  const linkRel = isExternal ? rel : undefined;
  return <section className="cta-callout not-prose relative my-8 w-full min-w-0 overflow-hidden rounded-xl border border-zinc-200 p-5 dark:border-white/10">
      <div className="cta-callout-noise" aria-hidden="true" />
      <div className="cta-callout-layout">
        {title ? <div className="cta-callout-title-row">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 28 28" width="14" height="14" className="cta-callout-icon shrink-0 text-zinc-800 dark:text-zinc-200" aria-hidden="true">
              <g fill="none" fillRule="nonzero">
                <path d="M28 0v28H0V0h28ZM14.691833333333335 27.134333333333334l-0.012833333333333334 0.0023333333333333335 -0.08283333333333333 0.04083333333333334 -0.023333333333333334 0.004666666666666667 -0.016333333333333335 -0.004666666666666667 -0.08283333333333333 -0.04083333333333334c-0.011666666666666667 -0.004666666666666667 -0.022166666666666668 -0.0011666666666666668 -0.028000000000000004 0.005833333333333334l-0.004666666666666667 0.011666666666666667 -0.019833333333333335 0.49933333333333335 0.005833333333333334 0.023333333333333334 0.011666666666666667 0.015166666666666667 0.12133333333333333 0.08633333333333333 0.0175 0.004666666666666667 0.014000000000000002 -0.004666666666666667 0.12133333333333333 -0.08633333333333333 0.014000000000000002 -0.018666666666666668 0.004666666666666667 -0.019833333333333335 -0.019833333333333335 -0.4981666666666667c-0.0023333333333333335 -0.011666666666666667 -0.0105 -0.019833333333333335 -0.019833333333333335 -0.021Zm0.3091666666666667 -0.13183333333333336 -0.015166666666666667 0.0023333333333333335 -0.21583333333333335 0.1085 -0.011666666666666667 0.011666666666666667 -0.0035000000000000005 0.012833333333333334 0.021 0.5016666666666667 0.005833333333333334 0.014000000000000002 0.009333333333333334 0.008166666666666668 0.23450000000000004 0.1085c0.014000000000000002 0.004666666666666667 0.026833333333333334 0 0.03383333333333334 -0.009333333333333334l0.004666666666666667 -0.016333333333333335 -0.03966666666666667 -0.7163333333333334c-0.0035000000000000005 -0.014000000000000002 -0.011666666666666667 -0.023333333333333334 -0.023333333333333334 -0.025666666666666667Zm-0.8341666666666667 0.0023333333333333335a0.026833333333333334 0.026833333333334334 0 0 0 -0.0315 0.007000000000000001l-0.007000000000000001 0.016333333333333335 -0.03966666666666667 0.7163333333333334c0 0.014000000000000002 0.008166666666666668 0.023333333333333334 0.019833333333333335 0.028000000000000004l0.0175 -0.0023333333333333335 0.23450000000000004 -0.1085 0.011666666666666667 -0.009333333333333334 0.004666666666666667 -0.012833333333333334 0.019833333333333335 -0.5016666666666667 -0.0035000000000000005 -0.014000000000000002 -0.011666666666666667 -0.011666666666666667 -0.21466666666666667 -0.10733333333333334Z" strokeWidth="1.1667" />
                <path fill="currentColor" d="M14 2.916666666666667A1.75 1.75 0 0 1 15.750000000000002 4.666666666666667v6.302333333333334L21.207666666666668 7.816666666666667a1.75 1.75 0 0 1 1.75 3.031L17.5 14l5.457666666666667 3.151166666666667a1.75 1.75 0 0 1 -1.75 3.031l-5.457666666666667 -3.1500000000000004V23.333333333333336a1.75 1.75 0 0 1 -3.5 0v-6.302333333333334L6.792333333333334 20.183333333333337a1.75 1.75 0 1 1 -1.75 -3.031L10.5 14 5.042333333333334 10.848833333333333a1.75 1.75 0 0 1 1.75 -3.031l5.457666666666667 3.1500000000000004V4.666666666666667A1.75 1.75 0 0 1 14 2.916666666666667Z" strokeWidth="1.1667" />
              </g>
            </svg>
            <p className="cta-callout-title min-w-0 font-semibold text-zinc-800 dark:text-zinc-200">
              {title}
            </p>
          </div> : null}
        <div className={`cta-callout-body text-sm leading-normal text-zinc-800 dark:text-zinc-200${title ? " cta-callout-body--indented" : ""}`}>
          {children}
        </div>
        <a href={href} target={target} rel={linkRel} onClick={handleCtaClick} data-docs-cta={trackingEvent || undefined} className="cta-callout-button inline-flex items-center justify-center gap-1 rounded-full bg-white px-3 py-1.5 text-sm font-semibold transition hover:bg-zinc-100 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-white/50 dark:bg-white dark:hover:bg-zinc-200">
          {buttonLabel}
          <span className="cta-callout-button-arrow" aria-hidden="true">
            →
          </span>
        </a>
      </div>
    </section>;
};

<Info>Available in version 0.8.2 and later.</Info>

With the [Update Metadata](/reference/update-metadata) endpoint, you can modify existing metadata or add new metadata to ledgers, transactions, identities, and balances after they have been created.

<Note>
  **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.
</Note>

***

## How it works

<Steps titleSize="h3">
  <Step title="Initial metadata">
    Consider the following metadata attached to an item:

    ```json theme={"system"}
    {
      ...
      "meta_data": {
        "first_name": "Jason"
      }
    }
    ```
  </Step>

  <Step title="Adding more metadata">
    To add a last name and verification status, send a POST request to:

    <CodeGroup>
      ```bash cURL wrap theme={"system"}
      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"
          }
        }'
      ```

      ```typescript TypeScript wrap theme={"system"}
      const response = await blnk.Metadata.update(
        '{id}',
        {
          meta_data: {
            last_name: 'Brooks',
            verification_status: 'Pending',
          },
        },
      );
      ```

      ```go Go wrap theme={"system"}
      meta, resp, err := client.Metadata.UpdateMetadata(
        "{id}",
        blnkgo.UpdateMetaDataRequest{
          MetaData: map[string]interface{}{
            "last_name":            "Brooks",
            "verification_status": "Pending",
          },
        },
      )
      ```
    </CodeGroup>

    ```json Response theme={"system"}
    {
      "meta_data": {
        "first_name": "Jason",
        "last_name": "Brooks",
        "verification_status": "Pending"
      }
    }
    ```
  </Step>

  <Step title="Updating metadata">
    To update the verification status, send the following request:

    <CodeGroup>
      ```bash cURL wrap theme={"system"}
      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"
          }
        }'
      ```

      ```typescript TypeScript wrap theme={"system"}
      const response = await blnk.Metadata.update(
        '{id}',
        {
          meta_data: {
            verification_status: 'Approved',
          },
        },
      );
      ```

      ```go Go wrap theme={"system"}
      meta, resp, err := client.Metadata.UpdateMetadata(
        "{id}",
        blnkgo.UpdateMetaDataRequest{
          MetaData: map[string]interface{}{
            "verification_status": "Approved",
          },
        },
      )
      ```
    </CodeGroup>

    ```json Response theme={"system"}
    {
      "meta_data": {
        "first_name": "Jason",
        "last_name": "Brooks",
        "verification_status": "Approved"
      }
    }
    ```

    <Info>
      **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](/changelog/v14-migration) for details.
    </Info>
  </Step>

  <Step title="Final metadata">
    After these updates, the metadata for the item will look like this:

    ```json theme={"system"}
    {
      ...
      "meta_data": {
        "first_name": "Jason",
        "last_name": "Brooks",
        "verification_status": "Approved"
      }
    }
    ```
  </Step>
</Steps>

***

## 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](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).

<CtaCallout title="Connect your ledger to Blnk Cloud" href="https://cloud.blnkfinance.com/auth/sign-up?utm_source=blnk_docs&utm_medium=documentation&utm_campaign=need-help" buttonLabel="Open Blnk Cloud" trackingEvent="clicked_cloud_signup">
  Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.
</CtaCallout>
