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 a current snapshot of a site's 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(options: GetSitePropertiesOptions): Promise<PropertiesReadResponse>
Method Parameters
optionsGetSitePropertiesOptions
Field options.
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.

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, fields: Array<string>): Promise<void>
Method Parameters
businessContactBusinessContactDataRequired
The site's business contact information.

fieldsArray<string>Required
The properties of businessContact to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from businessContact are cleared.
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.

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, fields: Array<string>): Promise<void>
Method Parameters
businessProfileBusinessProfileDataRequired
The site's business profile.

fieldsArray<string>Required
The properties of businessProfile to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from businessProfile are cleared.
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 a site's business schedule.

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