Collection Endpoints

Modify collection metadata

Changed on

Update an existing collection's metadata.

patch/api/v2/collections/{slug}

Request

Path parameters

slugstring required

Collection slug

Request body

authorized_editorsstring[] nullable

Authorized editors

banner_image_tokenstring nullable

Banner image token

buyer_side_creator_fee_basis_pointsinteger nullable

Buyer-side creator fee basis points

buyer_side_creator_fee_enabledboolean nullable

Whether buyer-side creator fees are enabled

buyer_side_creator_fee_recipientstring nullable

Buyer-side creator fee recipient

categorystring nullable

Collection category. Creators can no longer set or change it: any value other than the current one is rejected with 400, and OpenSea support handles category changes.

descriptionstring nullable

Collection description

external_urlstring nullable

Website URL shown on the collection page

is_nsfwboolean nullable

Whether the collection is NSFW

is_rarity_disabledboolean nullable

Whether rarity is disabled

is_trait_offers_enabledboolean nullable

Whether trait offers are enabled

logo_image_tokenstring nullable

Logo image token

medium_usernamestring nullable

Medium username

namestring nullable

Collection name

slugstring nullable

New collection slug: 1 to 50 lowercase letters, numbers and hyphens. Renaming releases the old slug at once. It does not redirect: requests for it return 404 once cached responses expire (a few minutes), and any other collection can claim it, after which it serves that collection. Update links that use the old slug. Verified collections cannot change their slug.

telegram_urlstring nullable

Collection Telegram URL

Response

Collection metadata updated successfully

successboolean required

Whether the collection metadata was modified successfully

Changes

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the media type */* for the response with the status

    • info

      added the media type */* for the response with the status

    • info

      added the media type */* for the response with the status

    • info

      added the optional property to the response with the status