Skip to main content
PUT
Update Store Settings
Patch a whitelisted subset of fields on the merchant’s general store settings. The endpoint silently ignores unknown fields if any allowed field is also present, but returns 400 when the request contains only non-whitelisted fields. This prevents accidental privilege escalation (e.g., trying to set id, password, role flags, etc.). Required scope: write_settings

Allowed fields

Only the following fields are writable: name, business, businessEmail, phone, profileImage, storeURL, category, country, storeAdd, gstNumber, availableCountries, availableLanguages, defaultLanguage, useManualExchangeRates, manualExchangeRates, currencyConversionFee. Any other field (e.g. id, email, password, internal flags) is rejected.

Request Body

string
Store display name.
string
Legal business name.
string
Business contact email.
string
Phone number.
string
Logo / profile image URL.
string
Custom store URL slug.
string
Store category.
string
ISO country code.
object
Store address.
string
Tax / GST registration number.
array
Countries the store ships to.
array
Languages the storefront supports.
string
Default language code.
boolean
Toggle manual exchange rates.
object
Currency → rate map.
number
Surcharge on converted prices.

Response

On success, returns the updated settings object — same shape as Get Store Settings. If no writable fields are supplied, returns 400 with a helpful message listing the allowed fields.