Skip to main content
PATCH
/
v1
/
admin
/
storefront
/
settings
Update storefront settings
curl --request PATCH \
  --url https://{operatorDomain}/v1/admin/storefront/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brandName": "<string>",
  "primaryColor": "<string>",
  "domains": [
    "<string>"
  ],
  "checkoutEnabled": true
}
'
{
  "brandName": "<string>",
  "primaryColor": "<string>",
  "domains": [
    "<string>"
  ],
  "checkoutEnabled": true
}

Authorizations

Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Body

application/json
brandName
string | null
primaryColor
string | null
domains
string[]
checkoutEnabled
boolean

Response

200 - application/json

Updated settings

brandName
string | null
primaryColor
string | null
domains
string[]
checkoutEnabled
boolean