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

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

const wishlist = await client.wishlists.update('wl_abc123', {
  name: 'Updated Name',
}, {
  token: '<token>',
})
curl --request PATCH \
  --url http://{defaultHost}/api/v3/store/wishlists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-spree-api-key: <api-key>' \
  --data '
{
  "name": "Updated Name",
  "is_private": true,
  "is_default": false
}
'
{
  "id": "wl_UkLWZg9DAJ",
  "name": "Updated Name",
  "token": "wtMUcDqiyhbWHFCF11dD7oCn",
  "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
is_default
boolean
required
is_private
boolean
required
items
object[]