Overview

Asset notes lets you attach short, tenant-specific notes to assets in your Fireblocks Console or through the Fireblocks API.

This feature helps your team stay aligned when managing large volumes of assets or similarly named tokens by adding context directly where you need it.

Key benefits

• Improve clarity: add context to avoid confusion between similar tokens.
• Streamline operations: operators can see guidance at a glance during swaps, transfers, or checks.
• Audit-ready: all notes are captured in your application audit log.
• Flexible access: add or edit notes from the Console or programmatically through the API.

Scope and limitations

• Each tenant can store one note per asset at a given time. A new note overwrites its predecessor.
• Notes are tenant-specific: they are not visible to other Fireblocks customers.
• Notes are visible across Console (Web) and the Mobile app.
• Notes can be created, updated, or deleted by users with Editor or higher roles.
• Notes are limited to 70 characters.

Using Asset notes in the Console

1. Open the Assets page in the Fireblocks Console.
2. Select the asset you want to annotate.
3. In the asset details panel, look for the Notes section.
4. Enter your text (up to 70 characters).
5. Click outside the modal to save the note.
   
   

The note will now appear wherever the asset is displayed in the Console.

Example

A team managing tokens called Trump Coin and Official Trump Coin can add notes to distinguish them:

• Trump Coin: “Legacy token — do not use it for transfers.”
• Official Trump Coin: “Active token, approved for operations.”

This prevents costly errors when handling assets with similar names.

Using Asset notes via API

Add or update a note

Send a PATCH request to /v1/assets/:id:

{

  "metadata": {

    "note": {

      "text": "Approved for daily settlements"

    }

  }

}

• To update a note: send the new text.
• To delete a note: send "text": null.

Response: The updated AssetResponseDto, including the new metadata.note field.

Retrieve notes

Notes are returned automatically in asset responses.

Each response may include:

"metadata": {

  "note": {

    "text": "Approved for daily settlements",

    "userId": "uuid-of-editor",

    "userName": "Jane Doe",

    "updatedAt": "2025-05-14T12:34:56Z"

  }

}

Audit Log

• All actions on Asset notes (create, update, delete) are recorded in the application audit log.
• The log captures the note’s text, the user who made the change, and the timestamp.