DELETE
/
2022-06-09
/
collections
/
{collectionId}
/
nfts
/
{id}
curl --request DELETE \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "action": "nfts.delete",
  "actionId": "201520fc-e0eb-4698-a2f3-c6b50cc7c894",
  "completedAt": "succeeded status ONLY - 2024-01-10T23:02:00.000Z",
  "data": {
    "chain": "polygon",
    "collection": {
      "contractAddress": "0x67a602CBb306b3DBaaC7ECf55b72EED0E04Dc785",
      "id": "default-polygon"
    },
    "token": {
      "id": "799a6f68-e2ea-4126-8577-4298dfcf900c",
      "tokenId": "7"
    },
    "txId": "succeeded status ONLY - 0x69cf6d971e6745f25f683db9c87663839be02bdaa4a70f0724f490d7335b0081"
  },
  "resource": "https://staging.crossmint.com/api/2022-06-09/collections/default-polygon/nfts/201520fc-e0eb-4698-a2f3-c6b50cc7c894",
  "startedAt": "2024-01-10T23:01:45.000Z",
  "status": "pending OR succeeded"
}

This is an alpha API and subject to change.

Authorizations

X-API-KEY
string
headerrequired

Obtained in the Crossmint developer console

Path Parameters

collectionId
string
required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the intitial request. Example: your-custom-identifer

id
string
required

Unique ID of the minted NFT returned in the mint response

Response

200 - application/json
action
string

The action performed, in this case nfts.delete

actionId
string

Can be used to check the status via the action status API

completedAt
string

The time this operation completed in UTC.

This is only present when status is succeeded

data
object
resource
string

The URL path to obtain current status with action status api

startedAt
string

The time this operation was initiated in UTC.

status
string

Current status of the async operation. One of pending or succeeded