Canvas Create Appointment Group
Creates a new appointment group in Canvas for schedulable time slots within specified course or group contexts.
Write ActionRisk level 2 of 5API key connectionFree Action
Creates a new appointment group in Canvas for schedulable time slots within specified course or group contexts.
titleRequiredstringTitle for the appointment group (e.g., 'Office Hours').
publishbooleanIf `True`, publishes the appointment group making it visible for sign-ups.
descriptionstringLonger description or instructions for participants.
context_codesRequiredarrayContext codes (e.g., 'course_123') to link this appointment group; at least one is required.
location_namestringName of the location (e.g., 'Room 301', 'Online via Zoom').
location_addressstringAddress for the location (e.g., physical address or meeting URL).
new_appointmentsarrayNested array of start/end time pairs (ISO 8601 format) indicating time slots for this appointment group. Each inner list should contain exactly 2 strings: [start_time, end_time].
sub_context_codesarraySub-context codes (e.g., 'section_789') to further restrict the group within primary `context_codes`.
allow_observer_signupbooleanIf `True`, allows users with an observer role (e.g., parents, mentors) to sign up.
participant_visibilitystringControls sign-up visibility: 'private' (organizers only see sign-ups) or 'protected' (participants see others in the same slot).
participants_per_appointmentintegerMaximum participants per time slot. If unspecified, Canvas may apply a default or allow unlimited.
max_appointments_per_participantintegerMaximum time slots a participant can sign up for; prevents overbooking.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.