Calendar Create

Last updated: 4 Dec 2025

Overview #

This allows developers to create calendars for providers in Canvas. Calendars can be either Clinic or Administrative type and can optionally be associated with a location.

from canvas_sdk.effects.calendar import Calendar, CalendarType

Calendar(
   provider="provider-uuid",
   type=CalendarType.Clinic,
   location="location-uuid",
   description="Primary clinic calendar"
).create()

Structure #

CalendarType #

An enumeration of calendar types:

Value	Description
Clinic	Calendar for clinical appointments
Administrative	Calendar for administrative tasks

Calendar #

A Calendar effect consists of the following properties:

Attributes #

Attribute	Type	Description
id	str \| UUID \| None	Optional unique identifier for the calendar.
provider	str \| UUID	The provider UUID
type	CalendarType	The type of calendar - either CalendarType.Clinic or CalendarType.Administrative
location	str \| UUID \| None	location UUID to associate with the calendar.
description	str \| None	description of the calendar’s purpose.