Update an NFT

There are two API methods to update an NFT.

• PATCH allows for partial updates so you can just pass in the image or the attribute you want to update

• PUT requires the full NFT metadata to be passed in and updates the full metadata

If you just want to make a change to a single attribute or just update the image, the PATCH endpoint should be sufficient.

If you are trying to remove attributes, you'll need to use the PUT endpoint to pass in the new attribute body.

Partial Update an NFT

Update an NFT

This endpoint allows you to perform an update on an NFT.

PUThttps://api.underdogprotocol.com/v1/nfts/:mintAddress

Authorization

bearerAuth

Path parameters

mintAddress*string

Address for the NFT's or token's mint account

Body

application/json

descriptionstring

Description stored in the metadata

image*string

Image URL for your NFT

attributesobject

Key-value pairs of your NFT attributes

Response

200401403404

Returns an Updated NFT

Body

application/json

name*string

Name stored as on-chain metadata

symbolstring

Symbol stored as on-chain metadata

descriptionstring

Description stored in the metadata

image*string

Image URL for your NFT

animationUrlstring

Animation URL for your NFT

attributesobject

Key-value pairs of your NFT attributes

id*number

Unique ID for an NFT in a Project

projectIdnumber

The ID of the Project the NFT is part of

transferableboolean

Whether or not the NFT can be transferred based on the Project its a part of

mintAddress*string

Address for the NFT's or token's mint account

ownerAddressstring

Wallet addres for the NFT's owner

claimerAddressstring

Wallet address allowed to claim the NFT

status*string

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v1/nfts/:mintAddress', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "image": "https://example.com/image.png"
    }),
});
const data = await response.json();

Response

{
  "name": "NFT #1",
  "symbol": "NFT",
  "description": "This is my first NFT",
  "image": "https://example.com/image.png",
  "animationUrl": "https://example.com/animation.mp4",
  "attributes": {
    "Points": "40000",
    "Nickname": "LeGoat"
  },
  "id": 0,
  "projectId": 0,
  "transferable": false,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "status": "text"
}

Example

cURL

curl -X PATCH \
      --url https://api.underdogprotocol.com/v1/nfts/7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer {token}" \
      -d '
{
  "attributes": {
    "best player": "Tyrese Haliburton"
  }
}'

JavaScript

import axios from 'axios';

const mintAddress = '7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB';

const partialUpdateNft = async () => {
  try {
    const response = await axios.patch(`https://api.underdogprotocol.com/v1/nfts/${mintAddress}`, {
      attributes: {
        'best player': 'Tyrese Haliburton'
      }
    }, {
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${token}`
      }
    });

    console.log(response.data);
  } catch (error) {
    console.error(error);
  }
}

Update an NFT

Partial update an NFT

This endpoint allows you to perform a partial update on an NFT.

PATCHhttps://api.underdogprotocol.com/v1/nfts/:mintAddress

Authorization

bearerAuth

Path parameters

mintAddress*string

Address for the NFT's or token's mint account

Body

application/json

descriptionstring

Description stored in the metadata

imagestring

Image URL for your NFT

attributesobject

Key-value pairs of your NFT attributes

Response

200401403404

Returns an Updated NFT

Body

application/json

name*string

Name stored as on-chain metadata

symbolstring

Symbol stored as on-chain metadata

descriptionstring

Description stored in the metadata

image*string

Image URL for your NFT

animationUrlstring

Animation URL for your NFT

attributesobject

Key-value pairs of your NFT attributes

id*number

Unique ID for an NFT in a Project

projectIdnumber

The ID of the Project the NFT is part of

transferableboolean

Whether or not the NFT can be transferred based on the Project its a part of

mintAddress*string

Address for the NFT's or token's mint account

ownerAddressstring

Wallet addres for the NFT's owner

claimerAddressstring

Wallet address allowed to claim the NFT

status*string

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v1/nfts/:mintAddress', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "NFT #1",
  "symbol": "NFT",
  "description": "This is my first NFT",
  "image": "https://example.com/image.png",
  "animationUrl": "https://example.com/animation.mp4",
  "attributes": {
    "Points": "40000",
    "Nickname": "LeGoat"
  },
  "id": 0,
  "projectId": 0,
  "transferable": false,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "status": "text"
}

Example

cURL

curl -X PUT \
      --url https://api.underdogprotocol.com/v1/nfts/7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer {token}" \
      -d '
{
  "name": "Sacramento Kings",
  "description": "",
  "image": "https://arweave.net/U0PFVZ_LszARt7OgfSiLl--OrRmczn0cNAjw4tYerVQ",
  "attributes": {
    "best player": "Tyrese Haliburton"
  }
}'

JavaScript

import axios from 'axios';

const mintAddress = '7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB';

const updateNft = async () => {
  try {
    const response = await axios.put(`https://api.underdogprotocol.com/v1/nfts/${mintAddress}`, {
      name: 'Sacramento Kings',
      description: '',
      image: 'https://arweave.net/U0PFVZ_LszARt7OgfSiLl--OrRmczn0cNAjw4tYerVQ',
      attributes: {
        'best player': 'Tyrese Haliburton'
      }
    }, {
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${token}`
      }
    });

    console.log(response.data);
  } catch (error) {
    console.error(error);
  }
}