Update an NFT

Partial Update an NFT

Partial Update an NFT

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

PATCHhttps://api.underdogprotocol.com/v2/projects/:transferable/:projectId/nfts/:nftId

Authorization

bearerAuth

Path parameters

transferable*string

Value must be either 't' for transferable or 'n' for non-transferable

projectId*integer

nftId*integer

NFT ID

Body

application/json

descriptionstring

Description stored in the metadata

imagestring

Image URL for your NFT

attributesobject

Key-value pairs of your NFT attributes

animationUrlstring

Animation URL for your NFT

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/v2/projects/:transferable/:projectId/nfts/:nftId', {
    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 --location --request PATCH 'https://dev.underdogprotocol.com/v2/projects/n/4/nfts/1' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "attributes": {
        "points": "40000"
    }
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "attributes": {
    "points": "40000"
  }
});

let config = {
  method: 'patch',
  url: 'https://dev.underdogprotocol.com/v2/projects/n/4/nfts/1',
  headers: { 
    'Authorization': 'Bearer {token}', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "id": 1,
    "status": "confirmed",
    "mintAddress": "Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi",
    "name": "LeGoat",
    "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi/image.png",
    "attributes": {
        "points": "40000"
    }
}

Update an NFT

Update an NFT

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

PUThttps://api.underdogprotocol.com/v2/projects/:transferable/:projectId/nfts/:nftId

Authorization

bearerAuth

Path parameters

transferable*string

Value must be either 't' for transferable or 'n' for non-transferable

projectId*integer

nftId*integer

NFT ID

Body

application/json

descriptionstring

Description stored in the metadata

image*string

Image URL for your NFT

attributesobject

Key-value pairs of your NFT attributes

animationUrlstring

Animation URL for your NFT

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/v2/projects/:transferable/:projectId/nfts/:nftId', {
    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 --location --request PUT 'https://dev.underdogprotocol.com/v2/projects/n/4/nfts/1' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "LeKareem",
    "image": "https://upload.wikimedia.org/wikipedia/commons/a/a0/Kareem_Abdul-Jabbar_May_2014.jpg",
    "attributes": {
        "points": "40000"
    }
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "name": "LeKareem",
  "image": "https://upload.wikimedia.org/wikipedia/commons/a/a0/Kareem_Abdul-Jabbar_May_2014.jpg",
  "attributes": {
    "points": "40000"
  }
});

let config = {
  method: 'put',
  url: 'https://dev.underdogprotocol.com/v2/projects/n/4/nfts/1',
  headers: { 
    'Authorization': 'Bearer {token}', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "id": 1,
    "status": "confirmed",
    "mintAddress": "Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi",
    "name": "LeGoat",
    "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi/image.png",
    "attributes": {
        "points": "40000"
    }
}