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}

Edit NFT

cURL

curl --request PATCH \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id} \
  --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>"
      }
    ]
  },
  "reuploadLinkedFiles": true
}
'

import requests

url = "https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id}"

payload = {
    "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>"
            }
        ]
    },
    "reuploadLinkedFiles": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'}]
    },
    reuploadLinkedFiles: true
  })
};

fetch('https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
                ]
        ]
    ],
    'reuploadLinkedFiles' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id}"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"name\": \"Crossmint Example NFT\",\n    \"image\": \"https://www.crossmint.com/assets/crossmint/logo.png\",\n    \"description\": \"My NFT created via the mint API!\",\n    \"animation_url\": \"\",\n    \"attributes\": [\n      {\n        \"trait_type\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"reuploadLinkedFiles\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"name\": \"Crossmint Example NFT\",\n    \"image\": \"https://www.crossmint.com/assets/crossmint/logo.png\",\n    \"description\": \"My NFT created via the mint API!\",\n    \"animation_url\": \"\",\n    \"attributes\": [\n      {\n        \"trait_type\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"reuploadLinkedFiles\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"name\": \"Crossmint Example NFT\",\n    \"image\": \"https://www.crossmint.com/assets/crossmint/logo.png\",\n    \"description\": \"My NFT created via the mint API!\",\n    \"animation_url\": \"\",\n    \"attributes\": [\n      {\n        \"trait_type\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"reuploadLinkedFiles\": true\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": true,
  "message": "Invalid arguments or empty parameter <missing parameter>."
}

{
  "error": true,
  "message": "Malformed API key. / API key provided doesn't have required scopes."
}

{
  "error": true,
  "message": "Not found"
}

{
  "error": true,
  "message": "Please try again in a few minutes. If the issue still persists, contact Crossmint support."
}

Authorizations

X-API-KEY · string · header · required

Obtained in the Crossmint developer console

Path Parameters

collectionId · string · 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

id · string · required

Unique ID of the minted NFT returned in the mint response

Body

application/json

metadata · [EVM] Metadata Object · object string [Solana] Metadata Object · object [Solana] Metadata URL · object · required

Optional if baseURI is set.

Show child attributes

reuploadLinkedFiles · boolean

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

Response

200

application/json

The NFT metadata update action has been successfully been created.

actionId · string

Example:

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

action · string

Example:

"nfts.update"

status · string

Example:

"pending OR succeeded"

data · object

Show child attributes

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"