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. If importing events is enabled, you can call List Events 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 or List Connections.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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?