HomeBook an Intro CallStartup Program
API Endpoints

Create an external calendar for a resource

post
https://api-stage.onsched.com/v3/resource//externalCalendar

Create a new external calendar (Google, Outlook, etc.) for a resource.

Notes:

  • Path param id is the resource ID
  • For Google, calendarId is usually primary
  • One account/provider/mode per Resource, including pending setup; competing connections return 409
  • On initial sync, an authUrl is returned; the resource must follow it to grant permissions
  • Optional useOnSchedCalendarSelection: true enables guest hosted selection, then returns to stored returnUrl after save or skip. Omitted or false preserves the direct returnUrl callback or authenticated picker.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required
boolean
Defaults to false

Opt into OnSched guest calendar selection before returning to returnUrl. Omit or use false to preserve the existing OAuth redirect and authenticated picker.

uri | null

Stored OAuth return destination. By default the callback redirects here directly. With useOnSchedCalendarSelection true, the browser returns after hosted selection save or skip. Callback query overrides are ignored.

Responses

400

Invalid body.

401

Unauthorized.

403

Forbidden.

409

Resource already has a calendar connection or pending setup.

Updated 5 months ago

Did this page help you?
Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?