Edit NFT by Locator

Edit a minted NFT’s metadata using a Crossmint NFT locator.

API scope required: nfts.update

PATCH /v1-alpha1/nfts/{locator}

Try it

Edit NFT by Locator

cURL

curl --request PATCH \
  --url https://staging.crossmint.com/api/v1-alpha1/nfts/{locator} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "metadata": {
    "name": "Crossmint Example NFT",
    "image": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "My NFT created via the mint API!",
    "animation_url": "",
    "attributes": [
      {
        "trait_type": "<string>",
        "value": "<string>",
        "display_type": "boost_number"
      }
    ]
  },
  "reuploadLinkedFiles": true
}
'

200

{
  "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"
}

Currently, this route is restricted to EVM NFTs only.

Locator format: {chain}:{contractAddress}:{tokenId}

Example: polygon:0x5af0d9827e0c53e4799bb226655a1de152a425a5:23

Authorizations

X-API-KEY · string · header · required

Obtained in the Crossmint developer console

Path Parameters

locator · string · required

The locator of the NFT, which includes the blockchain, contract address, and token ID.

Example:

"polygon:0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045:52"

Body

application/json

metadata · object · required

Show child attributes

metadata. name · string · required

The name of your NFT (Max length: 32)

Maximum string length: 32

Example:

"Crossmint Example NFT"

metadata. image · string · required

Direct link to your NFT image

Example:

"https://www.crossmint.com/assets/crossmint/logo.png"

metadata. description · string · required

A brief description of the NFT (Max length: 64)

Maximum string length: 64

Example:

"My NFT created via the mint API!"

metadata. animation_url · string

EVM only

See more info here

Example:

""

metadata. attributes · object[]

Add attributes to your NFT

Show child attributes

metadata.attributes. trait_type · string · required

The name of the trait

metadata.attributes. value · string · required

The value of the trait

metadata.attributes. display_type · enum<string>

Display name of your attribute

Available options: boost_number, boost_percentage, number

reuploadLinkedFiles · boolean · required

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

Response

200

application/json

Success

actionId · string

Example:

"d5e24c69-530d-4efd-9201-e6f9d6f647e2"

action · string

Example:

"nfts.update"

status · string

Example:

"pending OR succeeded"

data · object

Show child attributes

data. txId · string

The onchain transaction ID related to the request.

This is only present when status is succeeded

Example:

"succeeded status ONLY - 0x69cf6d971e6745f25f683db9c87663839be02bdaa4a70f0724f490d7335b0081"

data. chain · string

Example:

"polygon"

data. collection · object

Show child attributes

data.collection. id · string

Example:

"c242dcdb-57a7-4944-af9f-2c1472fa70fb"

data.collection. contractAddress · string

Example:

"0xc0DeE392CBe1af5f8211A17EAffAA5c358C0fE6d"

data. token · object

Show child attributes

data.token. id · string

Example:

"27db27cf-1596-4ab0-9826-a6740ffce61a"

data.token. owner · object

Show child attributes

data.token.owner. walletAddress · string

Example:

"0x0794f3aa4521d19273D775a08289110523D34DD4"

data.token. tokenId · string

Example:

"1"

data. changes · string[]

Example:

["metadata"]

startedAt · string<date-time>

Example:

"2024-03-08T00:10:59.000Z"

completedAt · string<date-time>

The time this operation completed in UTC.

This is only present when status is succeeded

Example:

"succeeded status ONLY - 2024-03-08T00:11:01.000Z"

resource · string

Example:

"https://staging.crossmint.com/api/2022-06-09/collections/c242dcdb-57a7-4944-af9f-2c1472fa70fb/nfts/d5e24c69-530d-4efd-9201-e6f9d6f647e2"