v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

NFTs

Edit NFT

Edit a minted NFT's metadata on IPFS.

If you are using a custom baseURI, invoking this will overwrite the specific tokenURI for the edited token.

API scope required: nfts.update

patch/2022-06-09/collections/{collectionId}/nfts/{id}

Path parameters

collectionIdstring required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the initial request. Example: your-custom-identifier

idstring required

Unique ID of the minted NFT returned in the mint response

Request body

reuploadLinkedFilesboolean

Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]

Example request

{
  "metadata": {
    "name": "Crossmint Example NFT",
    "image": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "My NFT created via the mint API!"
  }
}

Response

The NFT metadata update action has been successfully been created.

actionIdstring

actionstring

statusstring

startedAtstring date-time

completedAtstring date-time

The time this operation completed in UTC.

This is only present when status is succeeded

resourcestring

Example response

{
  "actionId": "d5e24c69-530d-4efd-9201-e6f9d6f647e2",
  "action": "nfts.update",
  "status": "pending OR succeeded",
  "data": {
    "txId": "succeeded status ONLY - 0x69cf6d971e6745f25f683db9c87663839be02bdaa4a70f0724f490d7335b0081",
    "chain": "polygon",
    "collection": {
      "id": "c242dcdb-57a7-4944-af9f-2c1472fa70fb",
      "contractAddress": "0xc0DeE392CBe1af5f8211A17EAffAA5c358C0fE6d"
    },
    "token": {
      "id": "27db27cf-1596-4ab0-9826-a6740ffce61a",
      "owner": {
        "walletAddress": "0x0794f3aa4521d19273D775a08289110523D34DD4"
      },
      "tokenId": "1"
    },
    "changes": [
      "metadata"
    ]
  },
  "startedAt": "2024-03-08T00:10:59.000Z",
  "completedAt": "succeeded status ONLY - 2024-03-08T00:11:01.000Z",
  "resource": "https://staging.crossmint.com/api/2022-06-09/collections/c242dcdb-57a7-4944-af9f-2c1472fa70fb/nfts/d5e24c69-530d-4efd-9201-e6f9d6f647e2"
}