Skip to main content
PATCH
/
api
/
v2
/
platform
/
wishlists
/
{id}
Update a Wishlist
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/wishlists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wishlist": {
    "name": "<string>",
    "user_id": "<string>",
    "is_default": true,
    "is_private": true
  }
}
'
{
  "data": {
    "id": "29",
    "type": "wishlist",
    "attributes": {
      "name": "My Super Wishlist",
      "is_private": true,
      "is_default": false,
      "created_at": "2022-11-08T19:36:08.103Z",
      "updated_at": "2022-11-08T19:36:08.334Z",
      "token": "W4TY5oxqYi2kvpYs26XUPH3p",
      "variant_included": false
    },
    "relationships": {
      "wished_items": {
        "data": []
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Body

application/json
​
wishlist
object
required

Response

Record updated

​
data
object
required