Skip to main content

Create a delayed reveal collection

Issue a POST request to the collections endpoint to create a collection. Set the reveal_strategy to DELAYED and include the preview_metadata section.

The reveal strategy can only be set a creation. Once set, it cannot be changed.

POST https://admin-api.phosphor.xyz/v1/collections

See create a collection for more payload and response details.

  • preview_metadata usually contains fields, such as, title, description, image_url, and anything else that defines the metadata for your collection.
  • title is a required attribute.
Example payload
{
"name": "Collection ABC",
"default_item_type_id": null,
"image_url": null,
"reveal_strategy": "DELAYED",
"preview_metadata": {
"title": "Delayed drop",
"description": "This is a delayed drop.",
"image_url": "https://preview-image-url.com/img/test.png",
"meta_animation_url": "https://preview-image-url.com/img/test.gif",
"...": "..."
},
"deployment_request": {
"type": "PLATFORM",
"token_id_assignment_strategy": "AUTOMATIC",
"platform": {
"symbol": "ABC",
"variant": "FlexibleERC721"
},
"network_id": 59140
}
}
Example response
{
"default_item_type_id": null,
"deployment": {
"address": null,
"capabilities": [],
"network_id": null,
"symbol": "ABC",
"token_id_assignment_strategy": "AUTOMATIC",
"token_type": "ERC721",
"transaction_id": "a2556a16-bd64-4afd-bdbc-e8354d27169f"
},
"functions_enabled": false,
"id": "cba8a297-0f8b-43ee-8481-83669393d874",
"image_url": null,
"name": "Collection ABC",
"royalty_info": null,
"reveal_strategy": "DELAYED",
"reveal_hidden": true,
"preview_metadata": {
"description": "This is a delayed drop.",
"id": "8502c836-fe0c-4b8c-9db8-bc268acdec26",
"image_url": "https://preview-image-url.com/img/test.png",
"media": {
"image": {
"cid": null,
"full": "https://preview-image-url.com/img/test.png",
"original": "https://preview-image-url.com/img/test.png",
"thumb": "https://preview-image-url.com/img/test.png",
"tiny": "https://preview-image-url.com/img/test.png"
}
},
"meta_animation_url": "https://preview-image-url.com/img/test.gif",
"title": "Delayed drop"
}
}