API Reference

External app report_sync_status

put
https://api.vcita.biz/business/scheduling/v1/external_calendar_items/report_sync_status

Overview

Report the sync status after completing a calendar sync operation. Available for Staff and App tokens.

Prerequisite

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.

Required Fields

  • params.is_sync_successful is required
  • If unsynced_items is provided, each item must have entity_uid
  • If unsynced_calendars is provided, each item must have imported_calendar_name
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.

params
object
required

Status report of the sync operation.

string
required

Staff UID

Response

Updated 2 months ago

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

Updated 2 months ago