Title for the appointment group (e.g., 'Office Hours').
publishboolean
If `True`, publishes the appointment group making it visible for sign-ups.
descriptionstring
Longer description or instructions for participants.
context_codesarray
Required
Context codes (e.g., 'course_123') to link this appointment group; at least one is required.
location_namestring
Name of the location (e.g., 'Room 301', 'Online via Zoom').
location_addressstring
Address for the location (e.g., physical address or meeting URL).
new_appointmentsarray
Nested 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_codesarray
Sub-context codes (e.g., 'section_789') to further restrict the group within primary `context_codes`.
allow_observer_signupboolean
If `True`, allows users with an observer role (e.g., parents, mentors) to sign up.
participant_visibilitystring
Controls sign-up visibility: 'private' (organizers only see sign-ups) or 'protected' (participants see others in the same slot).
participants_per_appointmentinteger
Maximum participants per time slot. If unspecified, Canvas may apply a default or allow unlimited.
max_appointments_per_participantinteger
Maximum time slots a participant can sign up for; prevents overbooking.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not