disconnect( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Disconnects from an external calendar.

When an external calendar is disconnected, the external calendar connection's status is changed to DISCONNECTED.

After disconnecting, listEvents() no longer returns events from the disconnected external calendar. Exported Wix calendar sessions are deleted from the external calendar.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
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 disconnect.

Returns
Return Type:Promise<DisconnectResponse>
Was this helpful?
Yes
No