External app connect

Overview

Connect a staff member's calendar to an external calendar provider. Available for Staff and App tokens.

Prerequisite

Staff member must have a CalendarSync record (typically created via the vcita web UI or OAuth flow with an external calendar provider like Google or Outlook).

Note: This endpoint requires a synchronized calendar to be connected to the staff member's account. Calendar sync can be configured under Calendar Settings in the vcita dashboard.

Response

Returns the calendar sync configuration including the uid which can be used as external_calendar_uid for other operations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
calendar_sync
object
required

Calendar sync configuration. Both provider and account are required.

string
required

Staff UID

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json