Skip to main content
PATCH
/
api
/
v3
/
store
/
wishlists
/
{id}
Spree SDK
import { createSpreeClient } from '@spree/sdk'

const client = createSpreeClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const wishlist = await client.store.wishlists.update('wl_abc123', {
  name: 'Updated Name',
}, {
  bearerToken: '<token>',
})
{
  "id": "wl_UkLWZg9DAJ",
  "name": "Updated Name",
  "token": "X21SJ4Wna4Cy8cmheTUQtzX7",
  "created_at": "2026-03-06T16:06:52.923Z",
  "updated_at": "2026-03-06T16:06:52.974Z",
  "is_default": false,
  "is_private": true
}

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Authorization
string
header
required

JWT token for authenticated customers

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

id
string
required

Body

application/json
name
string
Example:

"Updated Name"

is_private
boolean
Example:

true

is_default
boolean
Example:

false

Response

200 - application/json

wishlist updated

id
string
required
name
string
required
token
string
required
created_at
string
required
updated_at
string
required
is_default
boolean
required
is_private
boolean
required
items
object[]