Update shop settings

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

guestEnabled?boolean

Allow anonymous (not logged-in) wishlists.

Defaulttrue

shareEnabled?boolean

Allow share-link creation.

Defaulttrue

sharePath?string

Shop page a share link points at; the token is appended as ?list=. Merchants name that page freely, so it is a setting rather than a hardcoded path.

Match^\/(?!\/)[^?#]*$

Default"/pages/wishlist"

metafieldSyncEnabled?boolean

Mirror customer wishlists into a customer metafield.

Defaultfalse

klaviyoConfigured?boolean

Read-only echo — the key itself is encrypted at rest and never returned.

Defaultfalse

strings?

locale → key → string overrides for the storefront components.

Default{}

headlessOrigins?array<>

CORS allow-list for public mode.

Default[]

klaviyoKey?|

Write-only. Encrypted at rest; null disconnects Klaviyo.

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/shop/settings" \  -H "Content-Type: application/json" \  -d '{}'

{  "guestEnabled": true,  "shareEnabled": true,  "sharePath": "/pages/wishlist",  "metafieldSyncEnabled": false,  "klaviyoConfigured": false,  "strings": {},  "headlessOrigins": []}

Update shop settings

Request Body

Response Body

defaultapplication/json

`application/json`