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:
listEvents()
to retrieve a list of events from the 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.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function updateSyncConfig(
connectionId: string,
syncConfig: ConnectionSyncConfig,
options: UpdateSyncConfigOptions,
): Promise<UpdateSyncConfigResponse>;
ID of the external calendar connection to update.
Updated sync configuration details.
import { externalCalendars } from "wix-bookings.v2";
async function updateSyncConfig(connectionId) {
const syncConfig = {
listEventFromCalendars: {
enabled: true,
calendars: {
calendars: [
{
id: "a68yu6lp6584z66zorp19z1ab",
},
{
id: "4xve0tohyhnrlzy3lp4zf7b07",
},
],
},
},
};
const { connection: updatedConnection } =
await externalCalendars.updateSyncConfig(connectionId, syncConfig);
return updatedConnection;
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.