Update an NFT

Partial Update an NFT

Partial Update an NFT

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

patch

/v2/projects/:transferable/:projectId/nfts/:nftId

Authorizations

Path parameters

transferablestringrequired

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

projectIdintegerrequired

nftIdintegerrequired

NFT ID

Body

descriptionstring

Description stored in the metadata

Example: This is my first NFT

imagestring

Image URL for your NFT

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

animationUrlstring

Animation URL for your NFT

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

attributesobject

Key-value pairs of your NFT attributes

Example: {"Points":"40000","Nickname":"LeGoat"}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.underdogprotocol.com/v2/projects/:transferable/:projectId/nfts/:nftId' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "This is my first NFT",
    "image": "https://example.com/image.png",
    "animationUrl": "https://example.com/animation.mp4",
    "attributes": {
      "Points": "40000",
      "Nickname": "LeGoat"
    }
  }'

200

401

403

404

200

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

Returns an Updated NFT

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.

put

/v2/projects/:transferable/:projectId/nfts/:nftId

Authorizations

Path parameters

transferablestringrequired

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

projectIdintegerrequired

nftIdintegerrequired

NFT ID

Body

descriptionstring

Description stored in the metadata

Example: This is my first NFT

imagestringrequired

Image URL for your NFT

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

animationUrlstring

Animation URL for your NFT

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

attributesobject

Key-value pairs of your NFT attributes

Example: {"Points":"40000","Nickname":"LeGoat"}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.underdogprotocol.com/v2/projects/:transferable/:projectId/nfts/:nftId' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "This is my first NFT",
    "image": "https://example.com/image.png",
    "animationUrl": "https://example.com/animation.mp4",
    "attributes": {
      "Points": "40000",
      "Nickname": "LeGoat"
    }
  }'

200

401

403

404

200

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

Returns an Updated NFT

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