updateSyncConfig( )

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 specified external calendar connection's sync configuration.

Use Update Sync Config to update a connection's syncConfig property. The syncConfig property contains settings for enabling, configuring, or disabling functionality, including:

  • Importing events from one or more specified calendars in the connected external calendar account. If this is enabled, use listEvents() to retrieve a list of events from the external calendar.
  • Exporting events from the Wix site's calendar to an external calendar.

To see an external calendar connection's existing sync configuration, use getConnection() or listConnections() and see the syncConfig property.

Note: Supported functionality depends on the provider. Use listProviders() to see details about providers' supported features.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
connectionIdstringRequired

ID of the external calendar connection to update.

syncConfigConnectionSyncConfigRequired

Updated sync configuration details.

optionsUpdateSyncConfigOptions
Returns
Return Type:Promise<UpdateSyncConfigResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?