About the Site Properties API

Site Properties are a set of business-related values associated with a particular Wix site. They are modeled as a stream of versioned events (as in an event-sourced system), which can be accessed in their current state or materialized into snapshots. (A snapshot is essentially a key-value container that represents site properties at a given point in time, or in a given version).

The Site Properties API is a service that holds all the public information about the site and business in a single place, including profile, contact details, schedule information, and consent policy. It’s a single source of truth for this data across Wix.

Wix users enter this information in the Wix Dashboard under Settings > Business Info.

With the Site Properties API, you can:

• Retrieve a site's current business information.
• Update its profile, contact information, business schedule, regional settings, and default consent policy.
• Listen for changes to site properties.

Site property categories

• Profile: Site display name, business name, description, and logo.
• Contact: Email address, phone number, fax number, and address.
• Schedule: Regular business hours and special exceptions.
• Region: Locale, language, multilingual settings, payment currency, and time zone.
• Consent policy: Default consent policy.
• Other information: Categories and business type.

Updating business region settings

Use the Update Business Region method to update a site's payment currency or time zone. Specify paymentCurrency, timeZone, or both in the field mask. Fields not included in the field mask remain unchanged. To clear a field, include it in the field mask and omit it from the business region object.

Specify payment currencies as 3-letter ISO-4217 codes, such as USD, and time zones as IANA time zone IDs, such as America/New_York.

Before you begin

It's important to note the following point before starting to code:

• Site property updates are limited to 30 requests per site in a 60-second period. Reaching the limit blocks further updates to the site for 60 seconds.

Consent Policy

To help site owners and app developers comply with privacy regulation guidelines such as GDPR and CCPA, Wix provides consent policies that can be used to restrict cookies and related technologies on Wix sites. Third parties can access and manage the default consent policy for a site using this API. The default consent policy is the consent policy initially applied to site visitors before they make any consent choices themselves, such as through a cookie consent banner. Read more about managing consent policies.

The consent policy includes the following types:

• Functional: Used to remember choices site visitors make to improve their experience (for example, language).
• Analytics: Lets the Wix user understand how visitors use the website (for example, which pages you visit), to provide statistics on how the website is used, improve the website by identifying any errors, and performance issues.
• Advertising/Marketing: Used to collect information about the impact of marketing campaigns performed in other websites.
• Essential: Lets the site visitor move around the website and use essential features like secure and private areas.
• Data To Third Parties: Lets the Wix user share data with other parties (includes the sale of data, as well sharing data for essential or enhanced functionality, for example, Google Analytics) - specifically for CCPA compliance.

For more information about the consent policy process for Wix users, see the following:

• About Consent Apps
• Displaying a Cookie Banner On Your Site
• Adding a “Do Not Sell Data” Link to Your Wix Site
• Important Information About Editor Elements - Third Party Apps

Language vs. Locale

• Language (for example, en) determines the site language that will be displayed to the user of user on the site. It’s a list of (currently) 29 languages that Wix supports. It's also used in the HTML of the site for SEO and browser support purposes.
• Locale (for example, en-US) determines the formats that will be used across the site: date and time, currency, units and measurements, and first day of the week.

Wix saves and supports both, in order to support all locales, even though Wix doesn't support all languages, and to allow special combinations, such as a site in Japanese for Wix users in the US.

Site Categories

A category that the Wix user selected when they set up a site.

Examples:
Business
Online Store
Music
Design
Blog
Beauty & Wellness
Portfolio & CV
Events
Photography
Restaurants & Food
Fitness
Technology Company
Real Estate Agency
Yoga Studio
Financial Consultant
Makeup Blog

Use cases

• Synchronize a site's regional settings with an external system.