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

This is an alpha API and subject to change.

Authorizations

​
X-API-KEY
string
header
required

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
Success.
​
actionId
string

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

Example:

"201520fc-e0eb-4698-a2f3-c6b50cc7c894"

​
action
string

The action performed, in this case nfts.delete

Example:

"nfts.delete"

​
status
string

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

Example:

"pending OR succeeded"

​
data
object
​
startedAt
string

The time this operation was initiated in UTC.

Example:

"2024-01-10T23:01:45.000Z"

​
completedAt
string

The time this operation completed in UTC.

This is only present when status is succeeded

Example:

"succeeded status ONLY - 2024-01-10T23:02:00.000Z"

​
resource
string

The URL path to obtain current status with action status api

Example:

"https://staging.crossmint.com/api/2022-06-09/collections/default-polygon/nfts/201520fc-e0eb-4698-a2f3-c6b50cc7c894"