Update a Project

Partial Update an Project

Partial Update a Project

This endpoint allows you to perform a partial update on a Project.

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

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 Project

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

id*number

Unique ID for a Project

mintAddress*string

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

transferable*boolean

Whether or not the NFTs in this project can be transferred

status*string

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v2/projects/:transferable/:projectId', {
    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",
  "id": 0,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "transferable": false,
  "status": "text"
}

Example

cURL

curl --location --request PATCH 'https://dev.underdogprotocol.com/v2/projects/n/1' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
    "image": "https://assets.pokemon.com/assets/cms2/img/pokedex/full/005.png"
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "image": "https://assets.pokemon.com/assets/cms2/img/pokedex/full/005.png"
});

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

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

Response

{
    "id": 1,
    "status": "confirmed",
    "mintAddress": "6ntqAJmmkJup9h9EX3B5vETCj6ZYhZNfmQ6Rqm2myGmE",
    "name": "Underdogs",
    "description": "Pokemnon",
    "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/6ntqAJmmkJup9h9EX3B5vETCj6ZYhZNfmQ6Rqm2myGmE/image.png"
}

Update a Project

Update a Project

This endpoint allows you to perform an update on a Project.

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

Authorization

bearerAuth

Path parameters

transferable*string

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

projectId*integer

Body

application/json

descriptionstring

Description stored in the metadata

image*string

Image URL for your NFT

animationUrlstring

Animation URL for your NFT

Response

200401403404

Returns an Updated Project

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

id*number

Unique ID for a Project

mintAddress*string

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

transferable*boolean

Whether or not the NFTs in this project can be transferred

status*string

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v2/projects/:transferable/:projectId', {
    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",
  "id": 0,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "transferable": false,
  "status": "text"
}

Example

cURL

curl --location --request PUT 'https://dev.underdogprotocol.com/v2/projects/n/1' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
    "image": "https://assets.pokemon.com/assets/cms2/img/pokedex/full/005.png",
    "description": "Pokemnon"
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "image": "https://assets.pokemon.com/assets/cms2/img/pokedex/full/005.png",
  "description": "Pokemnon"
});

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

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

Response

{
    "id": 1,
    "status": "confirmed",
    "mintAddress": "6ntqAJmmkJup9h9EX3B5vETCj6ZYhZNfmQ6Rqm2myGmE",
    "name": "Underdogs",
    "description": "Pokemnon",
    "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/6ntqAJmmkJup9h9EX3B5vETCj6ZYhZNfmQ6Rqm2myGmE/image.png"
}

Update Name & Symbol

Update Project Name

Update Project Name

This endpoint allows you to update the on-chain name for a Project.

PUThttps://api.underdogprotocol.com/v2/projects/:transferable/:projectId/name

Authorization

bearerAuth

Path parameters

transferable*string

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

projectId*integer

Body

application/json

name*string

Name stored as on-chain metadata

Response

202401403404

Body

application/json

transactionId*string

Transaction ID that identifies the Transaction generated by an API request

projectId*number

Unique ID for a Project

transferable*boolean

Whether or not the NFTs in this project can be transferred

mintAddress*string

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

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v2/projects/:transferable/:projectId/name', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "NFT #1"
    }),
});
const data = await response.json();

Response

{
  "transactionId": "text",
  "projectId": 0,
  "transferable": false,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"
}

Example

cURL

curl --location --request PUT 'https://dev.underdogprotocol.com/v2/projects/n/1/name' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Project"
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "name": "Project"
});

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

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

Response

{
    "transactionId": "b8bde20a-a689-4ce7-9199-b5e4ca08e1cc",
    "projectId": 1,
    "transferable": false,
    "mintAddress": "6ntqAJmmkJup9h9EX3B5vETCj6ZYhZNfmQ6Rqm2myGmE"
}

Update Project Symbol

Update Project Symbol

This endpoint allows you to update the on-chain symbol for a Project.

PUThttps://api.underdogprotocol.com/v2/projects/:transferable/:projectId/symbol

Authorization

bearerAuth

Path parameters

transferable*string

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

projectId*integer

Body

application/json

symbolstring

Symbol stored as on-chain metadata

Response

202401403404

Body

application/json

transactionId*string

Transaction ID that identifies the Transaction generated by an API request

projectId*number

Unique ID for a Project

transferable*boolean

Whether or not the NFTs in this project can be transferred

mintAddress*string

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

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v2/projects/:transferable/:projectId/symbol', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "transactionId": "text",
  "projectId": 0,
  "transferable": false,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"
}

Example

cURL

curl --location --request PUT 'https://dev.underdogprotocol.com/v2/projects/n/1/symbol \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
    "symbol": "TEST"
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "symbol": "TEST"
});

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

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

Response

{
    "transactionId": "b8bde20a-a689-4ce7-9199-b5e4ca08e1cc",
    "projectId": 1,
    "transferable": false,
    "mintAddress": "6ntqAJmmkJup9h9EX3B5vETCj6ZYhZNfmQ6Rqm2myGmE"
}