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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
function updateSyncConfig(
  connectionId: string,
  syncConfig: ConnectionSyncConfig,
): Promise<UpdateSyncConfigResponse>;
Method Parameters
connectionIdstringRequired

ID of the external calendar connection to update.

syncConfigConnectionSyncConfigRequired

Updated sync configuration details.

Returns
Return Type:Promise<UpdateSyncConfigResponse>
JavaScript
import { externalCalendars } from "@wix/bookings";

async function updateSyncConfig(connectionId, syncConfig) {
  const response = await externalCalendars.updateSyncConfig(
    connectionId,
    syncConfig,
  );
}
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?