Update IP Asset

Update an existing IP Asset

API scope required: nfts.update

PATCH /v1/ip/collections/{collectionId}/ipassets/{customerFacingId}

Update IP Asset

cURL

curl --request PATCH \
  --url https://staging.crossmint.com/api/v1/ip/collections/{collectionId}/ipassets/{customerFacingId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data @- <<EOF
{
  "ipAssetMetadata": {
    "title": "Harry Potter and the Philosopher's Stone",
    "createdAt": "1997-06-26T00:00:00",
    "ipType": "literature",
    "image": "https://example.com/book-cover.jpg",
    "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaUrl": "link_to_epub",
    "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaType": "application/epub+zip",
    "creators": [
      {
        "name": "JK Rowling",
        "email": "[e-mail]",
        "crossmintUserLocator": "email:[e-mail]:story",
        "description": "Author",
        "contributionPercent": 80,
        "socialMedia": [
          {
            "platform": "Wikipedia",
            "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
          }
        ]
      },
      {
        "name": "Thomas Taylor",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Illustrator",
        "contributionPercent": 15
      },
      {
        "name": "Bloomsbury Publishing",
        "email": "[e-mail]",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Publisher",
        "contributionPercent": 5,
        "socialMedia": [
          {
            "platform": "Website",
            "url": "https://www.bloomsbury.com/"
          }
        ]
      }
    ],
    "media": [
      {
        "name": "ePub",
        "url": "link_to_epub",
        "mimeType": "application/epub+zip"
      },
      {
        "name": "Book Summary PDF",
        "url": "link_to_book_summary_pdf",
        "mimeType": "application/pdf"
      }
    ],
    "attributes": [
      {
        "key": "ISBN",
        "value": "978-0-7475-3269-0"
      },
      {
        "key": "Genre",
        "value": "Fantasy"
      }
    ]
  },
  "licenseConfig": {
    "mintingFee": 100,
    "licenseTermsId": "1"
  },
  "reuploadLinkedFiles": true
}
EOF

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "nftMetadata": {
    "name": "Art #123",
    "description": "A unique story NFT",
    "image": "https://example.com/nft/123.png"
  },
  "ipAssetMetadata": {
    "title": "Harry Potter and the Philosopher's Stone",
    "createdAt": "1997-06-26T00:00:00",
    "ipType": "literature",
    "image": "https://example.com/book-cover.jpg",
    "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaUrl": "link_to_epub",
    "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaType": "application/epub+zip",
    "creators": [
      {
        "name": "JK Rowling",
        "email": "[e-mail]",
        "crossmintUserLocator": "email:[e-mail]:story",
        "description": "Author",
        "contributionPercent": 80,
        "socialMedia": [
          {
            "platform": "Wikipedia",
            "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
          }
        ]
      },
      {
        "name": "Thomas Taylor",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Illustrator",
        "contributionPercent": 15
      },
      {
        "name": "Bloomsbury Publishing",
        "email": "[e-mail]",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Publisher",
        "contributionPercent": 5,
        "socialMedia": [
          {
            "platform": "Website",
            "url": "https://www.bloomsbury.com/"
          }
        ]
      }
    ],
    "media": [
      {
        "name": "ePub",
        "url": "link_to_epub",
        "mimeType": "application/epub+zip"
      },
      {
        "name": "Book Summary PDF",
        "url": "link_to_book_summary_pdf",
        "mimeType": "application/pdf"
      }
    ],
    "attributes": [
      {
        "key": "ISBN",
        "value": "978-0-7475-3269-0"
      },
      {
        "key": "Genre",
        "value": "Fantasy"
      }
    ]
  },
  "derivData": {
    "parentIpIds": [
      "0x123"
    ],
    "licenseTermsIds": [
      1
    ],
    "maxMintingFee": 0,
    "maxRevenueShare": 100,
    "maxRts": 10000000
  },
  "onChain": {
    "chain": "story-testnet",
    "contractAddress": "0x123",
    "status": "success",
    "ipAssetId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "tokenId": "1",
    "txId": "0x123",
    "owner": "0x123",
    "explorerLink": "https://portal.story.foundation/assets/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280"
  },
  "licenseConfig": {
    "mintingFee": 100,
    "licenseTermsId": "1",
    "disabled": false
  },
  "licenseTerms": [
    {
      "type": "non-commercial-social-remixing"
    }
  ]
}

This API is still under development. Contact support for early access.

Headers

X-API-KEY · string · required

API key required for authentication

Path Parameters

collectionId · string · required

customerFacingId · string · required

Body

application/json

ipAssetMetadata · object · required

New metadata containing information about the IP asset itself

Show child attributes

Example:

{
  "title": "Harry Potter and the Philosopher's Stone",
  "createdAt": "1997-06-26T00:00:00",
  "ipType": "literature",
  "image": "https://example.com/book-cover.jpg",
  "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaUrl": "link_to_epub",
  "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaType": "application/epub+zip",
  "creators": [
    {
      "name": "JK Rowling",
      "email": "[e-mail]",
      "crossmintUserLocator": "email:[e-mail]:story",
      "description": "Author",
      "contributionPercent": 80,
      "socialMedia": [
        {
          "platform": "Wikipedia",
          "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
        }
      ]
    },
    {
      "name": "Thomas Taylor",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Illustrator",
      "contributionPercent": 15
    },
    {
      "name": "Bloomsbury Publishing",
      "email": "[e-mail]",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Publisher",
      "contributionPercent": 5,
      "socialMedia": [
        {
          "platform": "Website",
          "url": "https://www.bloomsbury.com/"
        }
      ]
    }
  ],
  "media": [
    {
      "name": "ePub",
      "url": "link_to_epub",
      "mimeType": "application/epub+zip"
    },
    {
      "name": "Book Summary PDF",
      "url": "link_to_book_summary_pdf",
      "mimeType": "application/pdf"
    }
  ],
  "attributes": [
    {
      "key": "ISBN",
      "value": "978-0-7475-3269-0"
    },
    { "key": "Genre", "value": "Fantasy" }
  ]
}

licenseConfig · object · required

Edit license config for the IP asset

Show child attributes

Example:

{ "mintingFee": 100, "licenseTermsId": "1" }

reuploadLinkedFiles · boolean · default: true

Controls whether external files (like images) in the metadata should be reuploaded to decentralized storage (IPFS) (true) or referenced with their original URLs (false). Default is True.

Example:

true

Response

200 - application/json

IP Asset updated

id · string · required

The id of the IPAsset

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

actionId · string · required

The action id for the IPAsset creation

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

nftMetadata · object · required

Metadata for the NFT representation of this IP asset

Show child attributes

Example:

{
  "name": "Art #123",
  "description": "A unique story NFT",
  "image": "https://example.com/nft/123.png"
}

ipAssetMetadata · object · required

Metadata containing information about the IP asset itself

Show child attributes

Example:

{
  "title": "Harry Potter and the Philosopher's Stone",
  "createdAt": "1997-06-26T00:00:00",
  "ipType": "literature",
  "image": "https://example.com/book-cover.jpg",
  "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaUrl": "link_to_epub",
  "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaType": "application/epub+zip",
  "creators": [
    {
      "name": "JK Rowling",
      "email": "[e-mail]",
      "crossmintUserLocator": "email:[e-mail]:story",
      "description": "Author",
      "contributionPercent": 80,
      "socialMedia": [
        {
          "platform": "Wikipedia",
          "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
        }
      ]
    },
    {
      "name": "Thomas Taylor",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Illustrator",
      "contributionPercent": 15
    },
    {
      "name": "Bloomsbury Publishing",
      "email": "[e-mail]",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Publisher",
      "contributionPercent": 5,
      "socialMedia": [
        {
          "platform": "Website",
          "url": "https://www.bloomsbury.com/"
        }
      ]
    }
  ],
  "media": [
    {
      "name": "ePub",
      "url": "link_to_epub",
      "mimeType": "application/epub+zip"
    },
    {
      "name": "Book Summary PDF",
      "url": "link_to_book_summary_pdf",
      "mimeType": "application/pdf"
    }
  ],
  "attributes": [
    {
      "key": "ISBN",
      "value": "978-0-7475-3269-0"
    },
    { "key": "Genre", "value": "Fantasy" }
  ]
}

derivData · object · required

Data for the parent IP asset and license terms (for derivative IP assets only)

Show child attributes

Example:

{
  "parentIpIds": ["0x123"],
  "licenseTermsIds": [1],
  "maxMintingFee": 0,
  "maxRevenueShare": 100,
  "maxRts": 10000000
}

onChain · object · required

Option 1

Option 2

Show child attributes

licenseConfig · object · required

License configuration for the IP asset

Show child attributes

Example:

{
  "mintingFee": 100,
  "licenseTermsId": "1",
  "disabled": false
}

licenseTerms · (Non-commercial Social Remixing License Terms · object | Commercial Use License Terms · object | Commercial Remix License Terms · object)[]

Licensing parameters for the IP asset, NOTE: For detailed and updated license terms, refer to the 'Get IP Asset License' endpoint

License parameters

Non-commercial Social Remixing License Terms

Commercial Use License Terms

Commercial Remix License Terms

Show child attributes

Example:

{ "type": "non-commercial-social-remixing" }