RefreshNFTMetadataByTokenIDRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/immutable/main/json-schema/immutable-refresh-nftmetadata-by-token-idrequest-schema.json",
  "title": "RefreshNFTMetadataByTokenIDRequest",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/immutable-metadata-api-openapi.yml#/components/schemas/RefreshNFTMetadataByTokenIDRequest",
  "type": "object",
  "properties": {
    "nft_metadata": {
      "type": "array",
      "description": "List of nft metadata to be refreshed. Total size of the list should not exceed 228 KiB",
      "maxItems": 250,
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/RefreshMetadataByTokenID"
      }
    }
  },
  "required": [
    "nft_metadata"
  ],
  "$defs": {
    "NFTMetadataAttribute": {
      "type": "object",
      "properties": {
        "display_type": {
          "description": "Display type for this attribute",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "number",
            "boost_percentage",
            "boost_number",
            "date"
          ]
        },
        "trait_type": {
          "description": "The metadata trait type",
          "type": "string"
        },
        "value": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ],
          "description": "The metadata trait value"
        }
      },
      "required": [
        "trait_type",
        "value"
      ]
    },
    "NFTMetadataRequest": {
      "type": "object",
      "description": "The NFT metadata. Total size of this object should not exceed 16 KiB",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the NFT"
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The description of the NFT"
        },
        "image": {
          "type": [
            "string",
            "null"
          ],
          "description": "The image url of the NFT"
        },
        "external_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The external link of the NFT"
        },
        "animation_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The animation url of the NFT"
        },
        "youtube_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The youtube link of the NFT"
        },
        "attributes": {
          "type": [
            "array",
            "null"
          ],
          "description": "List of Metadata attributes",
          "items": {
            "$ref": "#/$defs/NFTMetadataAttribute"
          }
        }
      }
    },
    "RefreshMetadataByTokenID": {
      "allOf": [
        {
          "$ref": "#/$defs/RefreshableNFTAttributes"
        },
        {
          "type": "object",
          "properties": {
            "token_id": {
              "type": "string",
              "description": "An `uint256` token id as string"
            }
          },
          "required": [
            "token_id"
          ]
        }
      ]
    },
    "RefreshableNFTAttributes": {
      "allOf": [
        {
          "$ref": "#/$defs/NFTMetadataRequest"
        }
      ],
      "required": [
        "name",
        "description",
        "image",
        "external_url",
        "animation_url",
        "youtube_url",
        "attributes"
      ]
    }
  }
}