Burn an NFT

Burns an NFT

post

This endpoint allows you to burn a non-transferable NFT.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

projectIdintegerRequired

nftIdintegerRequired

NFT ID

Responses

202Success

application/json

transactionIdstringRequired

Transaction ID that identifies the Transaction generated by an API request

projectIdnumberOptional

The ID of the Project the NFT is part of

nftIdnumberRequired

Unique ID for an NFT in a Project

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]*$

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post/v2/projects/n/:projectId/nfts/:nftId/burn

HTTPcURLJavaScriptPython

POST /v2/projects/n/:projectId/nfts/:nftId/burn HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "transactionId": "text",
  "projectId": 1,
  "nftId": 1,
  "transferable": true,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"
}

Example

cURL

curl --location --request POST 'https://dev.underdogprotocol.com/v2/projects/n/:projectId/nfts/:nftId/burn
--header 'Authorization: Bearer {token}'

JavaScript

const axios = require('axios');

let config = {
  method: 'post',
  url: 'https://dev.underdogprotocol.com/v2/projects/n/:projectId/nfts/:nftId/burn',
  headers: { 
    'Authorization': 'Bearer {token}'
  }
};

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

Response

{
    "nftId": 1,
    "projectId": 1,
    "transferable": false,
    "transactionId": "3945e22e-6c8d-42ce-894b-6f77b59df7bd",
    "mintAddress": "CTASofcsAKVg2wy7xu2r7LFx8H1N8THQCD8vSkvV5dqr"
}