disconnect( )

Disconnects a Wix schedule from an external calendar and deletes all Wix calendar events from the external calendar.

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

After disconnecting, List Events no longer returns events from the disconnected external calendar.

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

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?