Setup

To use the SiteProperties API, install the @wix/business-tools package using npm or Yarn:

Copy
1
npm install @wix/business-tools

or

Copy
1
yarn add @wix/business-tools

Then import { siteProperties } from @wix/business-tools:

Copy
1
import { siteProperties } from '@wix/business-tools'
Was this helpful?
Yes
No
getSiteProperties( )
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves site properties

The getSiteProperties() function returns a promise that resolves to the site properties.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Your App
Learn more about permission scopes.
Copy
function getSiteProperties(): Promise<PropertiesReadResponse>
Request
This method does not take any parameters
Returns
Return Type:Promise<PropertiesReadResponse>
Was this helpful?
Yes
No
updateBusinessContact( )
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a site's business contact information.

The updateBusinessContact() function returns a Promise that resolves when the site's contact information is updated.

Note:

  • Only the fields included in the fields parameter will be updated, even if they are included in the businessContact parameter.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Business Contact
Learn more about permission scopes.
Copy
function updateBusinessContact(businessContact: BusinessContactData): Promise<void>
Method Parameters
businessContactBusinessContactDataRequired
The site's business contact information.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
updateBusinessProfile( )
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a site's business profile information.

The updateBusinessProfile() function returns a Promise that resolves when the site's business profile information is updated.

Note:

  • Only the fields included in the fields parameter are updated, even if they are included in the businessProfile parameter.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Business Profile
Learn more about permission scopes.
Copy
function updateBusinessProfile(businessProfile: BusinessProfileData): Promise<void>
Method Parameters
businessProfileBusinessProfileDataRequired
The site's business profile.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
updateBusinessSchedule( )
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates the default location's business schedule.

The updateBusinessSchedule() function returns a Promise that resolves when the site's business schedule is updated.

Note:

  • The updateBusinessSchedule() function overwrites the current business schedule. businessSchedule is an array, so it must be written in its entirety. Therefore, you must modify the existing array and pass it in the function call.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Business Schedule
Learn more about permission scopes.
Copy
function updateBusinessSchedule(businessSchedule: BusinessSchedule): Promise<void>
Method Parameters
businessScheduleBusinessScheduleRequired
The site's business schedule in the site time zone.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
updateConsentPolicy( )
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a site's consent policy.

The updateConsentPolicy() function returns a Promise that resolves when the site's consent policy is updated.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Consent Policy
Learn more about permission scopes.
Copy
function updateConsentPolicy(consentPolicy: ConsentPolicy): Promise<void>
Method Parameters
consentPolicyConsentPolicyRequired
Default consent policy defined by the site owner. Can be further limited by site visitors.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No