PUT
/
v1
/
ip
/
collections
/
{collectionId}
curl --request PUT \
  --url https://staging.crossmint.com/api/v1/ip/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "reuploadLinkedFiles": true,
  "metadata": {
    "name": "My Collection",
    "symbol": "MYCOL",
    "description": "My Collection Description",
    "image": "https://example.com/image.png"
  },
  "chain": "story-testnet"
}'
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "metadata": {
    "name": "My Collection",
    "symbol": "MYCOL",
    "description": "My Collection Description",
    "image": "https://example.com/image.png"
  },
  "onChain": {
    "chain": "story-testnet",
    "contractAddress": "0x123"
  }
}
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

Body

application/json

Story Protocol collection creation input

​
metadata
object
required

Story Protocol collection metadata

Example:
{
  "name": "My Collection",
  "symbol": "MYCOL",
  "description": "My Collection Description",
  "image": "https://example.com/image.png"
}
​
chain
string
required

The chain of the collection, either story or story-testnet

Example:

"story-testnet"

​
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

​
supplyLimit
number

The supply limit of the collection

Example:

100

Response

201 - application/json
Collection created

Story Protocol collection creation output

​
id
string
required

The id of the collection

Example:

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

​
actionId
string
required

The action id of the collection

Example:

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

​
metadata
object
required

Story Protocol collection metadata response

Example:
{
  "name": "My Collection",
  "symbol": "MYCOL",
  "description": "My Collection Description",
  "image": "https://example.com/image.png"
}
​
onChain
object
required

Was this page helpful?

Create IP CollectionGet IP Collection