Edit NFT by Locator

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

API scope required: nfts.update

This is an alpha API and subject to change.

Currently, this route is restricted to EVM NFTs only.

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

Example: polygon:0x5af0d9827e0c53e4799bb226655a1de152a425a5:23

Authorizations

X-API-KEY

string

headerrequired

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.

Body

application/json

metadata

object

required

Show child attributes

metadata.name

string

required

The name of your NFT (Max length: 32)

Maximum length: 32

metadata.image

string

required

Direct link to your NFT image

metadata.description

string

required

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

Maximum length: 64

metadata.animation_url

string

EVM only

See more info here

metadata.attributes

object[]

Add attributes to your NFT

Show child attributes

metadata.attributes.display_type

enum<string>

Display name of your attribute

Available options:

boost_number,

boost_percentage,

number

metadata.attributes.trait_type

string

required

The name of the trait

metadata.attributes.value

string

required

The value of the trait

reuploadLinkedFiles

boolean

required

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

Response

200 - application/json

actionId

string

action

string

status

string

data

object

Show child attributes

data.txId

string

The onchain transaction ID related to the request.

This is only present when status is succeeded

data.chain

string

data.collection

object

Show child attributes

data.collection.id

string

data.collection.contractAddress

string

data.token

object

Show child attributes

data.token.id

string

data.token.owner

object

Show child attributes

data.token.owner.walletAddress

string

data.token.tokenId

string

data.changes

string[]

startedAt

string

completedAt

string

The time this operation completed in UTC.

This is only present when status is succeeded

resource

string