Skip to navigation
Calendar

Disconnect Calendar

View as Markdown

Disconnect a calendar account. By default its synced events and the bots scheduled from them are deleted too; pass purge_events=false to keep them. With several accounts connected, pass provider and account_id.

Authentication

AuthorizationToken

Format: Token <your_api_key>

Query parameters

providerenumOptionalDefaults to all

microsoft is an alias for outlook. Must not be all when account_id is set.

Allowed values:
account_idstringOptional
The connected account's email address.
purge_eventsbooleanOptionalDefaults to true
Also delete the account's synced events, their scheduled bots and schedules.

Request

This endpoint expects an object.
providerenumOptionalDefaults to all
Allowed values:
account_idstringOptional
purge_eventsbooleanOptionalDefaults to true

Response

Disconnected.
disconnectedbooleanOptional
user_idstringOptional
scopestringOptional

single_account, or the provider scope (all, google, outlook) when no account_id was sent.

purge_eventsbooleanOptional
resultslist of objectsOptional
messagestringOptional

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error