Edit a collection

Issue a PATCH request to the collections endpoint.

PATCH https://admin-api.phosphor.xyz/v1/collections/{collection_id}

Example payload

{
  "name": "ABC-FlexibleERC721",
  "image_url": "https://",
  "default_item_type_id": null,
  "royalty_info": {
    "receiver": "0x62a0FeB7BD2E6D5169106a6F6c355351C35BAf21",
    "amount_bps": 1000
  },
  "functions_enabled": true,
  "reveal_hidden": false,
  "preview_metadata": null,
  "editable_metadata": false
}

Parameter	Required?	Description
name	No	The name of the collection. Should be unique in your organization.
default_item_type_id	No	ID of the item type commonly associated with this collection.
image_url	No	URL of an image to be used as a cover image for the collection.
royalty_info	No	Sets a default contract-level royalty to an Ethereum address with an amount in bps, if the token contract supports ERC2981 NFT Royalty Standard.
functions_enabled	No	Whether to enable manual interaction with the contract through API calls.
reveal_hidden	No	Whether to hide the collection items' metadata. Default to true for a collection with DELAYED reveal strategy. Once false, it cannot be set to true again.
preview_metadata	No	Collection preview metadata shown on all items prior to triggering the reveal. Required when reveal_strategy=DELAYED
editable_metadata	No	Whether items' metadata are allowed to change after minted. Default to false when a collection was created. Once false, it cannot be set to true again.

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": true,
  "id": "cba8a297-0f8b-43ee-8481-83669393d874",
  "image_url": "https://",
  "name": "ABC-FlexibleERC721",
  "royalty_info": {
    "receiver": "0x62a0FeB7BD2E6D5169106a6F6c355351C35BAf21",
    "amount_bps": 1000
  },
  "editable_metadata": false,
  "reveal_hidden": false,
  "preview_metadata": null,
  "reveal_strategy": "INSTANT"
}