Account Endpoints

Update a profile shelf

Changed on Nov 3, 2026

Update shelf fields and optionally item descriptions. Shelf field updates are applied first; if a later item description update fails, earlier changes are not rolled back.

patch/api/v2/profile/shelves/{shelf_id}

Request

Base URL
https://api.opensea.io
Auth
API key in header x-api-key and OpenID Connect (https://auth.opensea.io/.well-known/openid-configuration, scopes: write:profile)
TypeScript
https://skmtc.dev/opensea/apis/opensea-api/docs/api/v2/profile/shelves/:shelf_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

shelf_idstring required

Request body

descriptionstring nullable

Shelf description

iconstring nullable

Shelf icon

single_item_shelf_sidestring nullable

Single-item shelf side

titlestring nullable

Shelf title

viewstring nullable

Shelf view

Response

Shelf updated successfully

account_addressstring nullable

descriptionstring nullable

display_orderinteger required

iconstring nullable

idstring required

shelf_item_metadataobject required

single_item_shelf_sidestring nullable

titlestring required