Use Calendar’s action guides to set up a host, offer availability, manage bookings and connect external calendars. Each guide explains inputs, effects, worked examples, verification and recovery.
Before you start
Confirm the intended identity, organization and discovered Calendar workspace. Permissions and resource bindings remain caller-specific. Privacy export and erasure operate across the authenticated organization; selecting a workspace does not narrow those operations.
Examples and source scope
The 31 guides below contain source-reviewed synthetic illustrations, not captured production outcomes. Twenty-five illustrative responses match their structural schemas; four disclose overlapping oneOf branches, one explains an empty HTTP 204 response and one is an explicitly partial widget excerpt. Source revision b378ceb73800ee1d1e6c4ff6f0b4179918cf632c is not a verified serving-source association. Inspect the live action contract before preparing a request.
Host profile
- Upload host avatar: Upload an avatar image and obtain its URL.
- Get host profile: Read the selected workspace host, including the unconfigured host:null state.
- Create or update host profile: Create the first host or replace its editable profile fields.
Availability
- Get availability: Read the current host’s complete weekly rules and date overrides.
- Create availability override: Create an override, or update a discovered override by its ID.
- Delete availability override: Remove one override and let the weekly schedule apply again.
- List availability overrides: Discover date override IDs before updating or deleting one.
- Update availability: Replace the entire weekly availability schedule.
Event types
- Create event type: Create an active event type with an explicit booking address and timing rules.
- Delete event type: Delete an event type only when no bookings reference it.
- Get event type: Read one known event type, including an inactive one.
- List event types: Discover active event types and their IDs.
- Update event type: Update a known event type without losing its identity.
Bookings
- Approve booking: Confirm a pending booking after checking its intended commitment.
- Cancel booking: Cancel one booking and release its slot.
- Create booking: Create a booking after discovering its event type and confirming the invitee/time.
- Get booking: Read a booking and its related event type and delivery receipts.
- Resend booking invite: Request another invitation or cancellation for the current booking.
- List bookings: Find bookings within an explicit time window.
- Reschedule booking: Move a booking to a specific new time.
- Update booking: Edit a booking’s time or invitee details.
External calendars
- Connect CalDAV calendar: Save a CalDAV connection through Nexus and a Calendar reference.
- Create external calendar: Register an ICS/manual calendar without importing busy time yet.
- Delete external calendar: Disconnect a calendar and remove its local busy-time effect.
- List external calendars: Discover external calendar IDs, connection state and sync history.
- Start calendar OAuth: Begin a human Google/Microsoft calendar authorization.
- Sync external calendar: Replace an external calendar’s imported busy-time snapshot.
Organization data
- Erase organization Calendar data: Permanently erase Calendar-owned data across an organization.
- Export organization Calendar data: Export Calendar-owned records for the authenticated organization.
Widget and workspace
- Get booking operations widget: Read the Calendar operational summary and its scope/state.
- Delete workspace: Archive an empty verified workspace through Auth and remove its local mirror.
Current action contracts
Use the Calendar action reference for current credential-scoped contracts. An example or guide does not authorize sending invitations, connecting a provider, exporting personal data or erasing records.