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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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 disconnect.

Returns
Return Type:Promise<DisconnectResponse>
Errors
428Failed Precondition

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Did this help?