updateSyncConfig( )

Updates the import and export settings for an external calendar connection's events.

A connection's syncConfig object determines:

  • Whether events from 1 or more accounts belonging to the external calendar are imported to the connected Wix schedule. (SDK | REST). If importing events is enabled, you can call List Events (SDK | REST) to retrieve external calendar events.
  • Whether events from the Wix schedule are exported to 1 or more accounts belonging to the external calendar.

To check the current import and export settings, you can call Get Connection (SDK | REST) or List Connections (SDK | REST).

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
Method Parameters
connectionIdstringRequired

ID of the external calendar connection to update.

syncConfigConnectionSyncConfigRequired

Updated sync configuration details.

Returns
Return Type:Promise<UpdateSyncConfigResponse>
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?