Edit an item

Edit an item using the Phosphor API.

Issue a PATCH request to the items endpoint.

PATCH https://admin-api.phosphor.xyz/v1/items/{item_id}

This is a full update, meaning each specified attribute overwrites the existing attribute, and item type attributes must be valid against the item type schema.

Attributes can't be updated after an item has been minted, unless the collection has specified editable_metadata to be true.

Example payload

{
  "attributes": {
    "title": "new-title",
    "description": "new-description",
    "image_url": "http://"
  },
  "item_type_id": "item-type-id",
  "royalty_info": {
    "receiver": "checksum-address",
    "amount_bps": 10000
  }
}

Parameter	Required?	Description
attributes	Yes	Varies by item-type. Usually contains title, description, image_url. title is a required field.
item_type_id	No	ID of the item type commonly associated with this collection.
royalty_info	No	Sets a default token-level royalty to an Ethereum address with an amount in bps, if the token contract supports ERC2981 NFT Royalty Standard.

Example response

{
  "attributes": {
    "description": "new-description",
    "image_url": "http://",
    "title": "new-title"
  },
  "collection_id": "960300ca-ad1e-4054-b056-77c3dcfd2b9d",
  "id": "ce67342d-9e0b-4fea-ad54-f668d7fd59ad",
  "item_type_id": "item-type-id",
  "locked": false,
  "max_supply": null,
  "media": {
    "image": {
      "cid": null,
      "full": "http://",
      "original": "http://",
      "thumb": "http://",
      "tiny": "http://"
    }
  },
  "royalty_info": {
    "receiver": "checksum-address",
    "amount_bps": 10000
  },
  "token_id": null,
  "token_status": "NOT_MINTED"
}