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

put

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

mintAddressstringRequired

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

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

Body

descriptionstringOptional

Description stored in the metadata

Example: This is my first NFT

imagestringRequired

Image URL for your NFT

Example: https://example.com/image.png

Responses

200

Returns an Updated NFT

application/json

namestringRequired

Name stored as on-chain metadata

Example: NFT #1

symbolstringOptional

Symbol stored as on-chain metadata

Example: NFT

descriptionstringOptional

Description stored in the metadata

Example: This is my first NFT

imagestringRequired

Image URL for your NFT

Example: https://example.com/image.png

animationUrlstringOptional

Animation URL for your NFT

Example: https://example.com/animation.mp4

idnumberRequired

Unique ID for an NFT in a Project

projectIdnumberOptional

The ID of the Project the NFT is part of

transferablebooleanOptional

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

mintAddressstringRequired

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

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

ownerAddressstringOptional

Wallet addres for the NFT's owner

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

claimerAddressstringOptional

Wallet address allowed to claim the NFT

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

statusstringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/v1/nfts/:mintAddress

PUT /v1/nfts/:mintAddress HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "description": "This is my first NFT",
  "image": "https://example.com/image.png",
  "attributes": {
    "Points": "40000",
    "Nickname": "LeGoat"
  }
}

{
  "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": 1,
  "projectId": 1,
  "transferable": true,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "status": "text"
}

Example

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

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

patch

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

mintAddressstringRequired

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

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

Body

descriptionstringOptional

Description stored in the metadata

Example: This is my first NFT

imagestringOptional

Image URL for your NFT

Example: https://example.com/image.png

Responses

200

Returns an Updated NFT

application/json

namestringRequired

Name stored as on-chain metadata

Example: NFT #1

symbolstringOptional

Symbol stored as on-chain metadata

Example: NFT

descriptionstringOptional

Description stored in the metadata

Example: This is my first NFT

imagestringRequired

Image URL for your NFT

Example: https://example.com/image.png

animationUrlstringOptional

Animation URL for your NFT

Example: https://example.com/animation.mp4

idnumberRequired

Unique ID for an NFT in a Project

projectIdnumberOptional

The ID of the Project the NFT is part of

transferablebooleanOptional

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

mintAddressstringRequired

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

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

ownerAddressstringOptional

Wallet addres for the NFT's owner

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

claimerAddressstringOptional

Wallet address allowed to claim the NFT

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

statusstringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/v1/nfts/:mintAddress

PATCH /v1/nfts/:mintAddress HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "description": "This is my first NFT",
  "image": "https://example.com/image.png",
  "attributes": {
    "Points": "40000",
    "Nickname": "LeGoat"
  }
}

{
  "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": 1,
  "projectId": 1,
  "transferable": true,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "status": "text"
}

Example

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

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);
  }
}

PreviousRetrieve an NFT NextManaged NFTs

Last updated 3 years ago

hashtagPartial Update an NFT

hashtagUpdate an NFT

hashtagExample

hashtagUpdate an NFT

hashtagPartial update an NFT

hashtagExample

Partial Update an NFT

Update an NFT

Example

Update an NFT

Partial update an NFT

Example