Canvas

Parámetros de entrada

• iconstringenum

  Icon to display with the notification.

  warninginformationquestionerrorcalendar
• end_atstringObligatorio

  End date/time for visibility (ISO8601 format); must be after `start_at`.

• messagestringObligatorio

  Main content/body of the notification.

• subjectstringObligatorio

  Subject line of the notification.

• start_atstringObligatorio

  Start date/time for visibility (ISO8601 format).

• account_idstringObligatorio

  Canvas account ID for the notification.

• notification_rolesstring[]

  Optional list of specific user role(s) to receive the notification (e.g., 'StudentEnrollment', 'TeacherEnrollment'); roles must be valid for the account. If omitted, Canvas defaults to broader visibility.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestringObligatorio

  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_codesstring[]Obligatorio

  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).

• sub_context_codesstring[]

  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_visibilitystringenum

  Controls sign-up visibility: 'private' (organizers only see sign-ups) or 'protected' (participants see others in the same slot).

  privateprotected
• 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.

• min_appointments_per_participantinteger

  Minimum time slots a participant must sign up for; useful for requiring multiple sessions.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the assignment.

• due_atstring

  Due date in ISO 8601 format.

• positioninteger

  Position in the assignment group's list; lower numbers appear first. If unspecified, added to the end.

• course_idintegerObligatorio

  ID of the course for the new assignment.

• publishedboolean

  If true, assignment is published and visible to students. Defaults to false (draft).

• unlock_atstring

  Date assignment becomes available to students, in ISO 8601 format.

• descriptionstring

  Detailed HTML description, including instructions or requirements.

• grading_typestring

  Grading type. Supported: 'pass_fail', 'percent', 'letter_grade', 'gpa_scale', 'points', 'not_graded'. Defaults to 'points' if unspecified.

• integration_idstring

  Unique identifier if managed by a third-party integration (e.g., LTI ID).

• points_possibleinteger

  Maximum points possible. Required unless grading_type is 'pass_fail' or 'not_graded'.

• allowed_attemptsinteger

  Number of submission attempts allowed. Use -1 for unlimited. Defaults to -1 (unlimited) if unspecified by the system.

• submission_typesstring[]

  Submission types allowed. Common: 'online_text_entry', 'online_upload', 'on_paper', 'none', 'external_tool'. If unspecified, Canvas often assumes 'none'.

• allowed_extensionsstring[]

  File extensions allowed if 'online_upload' is a submission type. If unspecified, all file types are allowed.

• assignment_group_idinteger

  ID of the assignment group for this assignment. If unspecified, may be added to a default or first available group.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  The title for this assignment override. Required if `student_ids` are specified to identify the ad-hoc group.

• due_atstring

  The new due date for the assignment for the targeted entity (students, group, or section). Must be in ISO 8601 format.

• lock_atstring

  The new lock date (when the assignment becomes unavailable) for the targeted entity. Must be in ISO 8601 format.

• group_idinteger

  The ID of the group to target with this override. All students in this group will be affected.

• course_idstringObligatorio

  The ID of the course where the assignment exists and the override will be applied.

• unlock_atstring

  The new unlock date (when the assignment becomes available) for the targeted entity. Must be in ISO 8601 format.

• student_idsinteger[]

  A list of student IDs to target with this override. If specified, a `title` is also required.

• assignment_idstringObligatorio

  The ID of the assignment for which this override is being created.

• course_section_idinteger

  The ID of the course section to target with this override. All students in this section will be affected.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• rrulestring

  iCalendar Recurrence Rule (RRULE) string for recurring events (e.g., 'FREQ=WEEKLY;BYDAY=MO,WE,FR'). Must define a finite series (include 'UNTIL' or 'COUNT').

• titlestring

  Short, descriptive title for the event.

• end_atstringdate-time

  End date/time of the event (ISO 8601 'YYYY-MM-DDTHH:MM:SSZ').

• all_dayboolean

  If true, event spans the entire day; `start_at` and `end_at` times are ignored (date portion only).

• start_atstringdate-time

  Start date/time of the event (ISO 8601 'YYYY-MM-DDTHH:MM:SSZ').

• duplicateobject

  Settings for creating a series of identical events. See `DuplicateSettings`.

• descriptionstring

  Detailed description; HTML allowed for rich formatting.

• context_codestringObligatorio

  Context code for the calendar, e.g., 'course_123' (course), 'group_456' (group), 'user_789' (user), or 'account_1' (account).

• blackout_dateboolean

  If true, marks a blackout date not considered in course pacing calculations.

• location_namestring

  Name of the event's location (e.g., 'Conference Room A', 'Online').

• child_event_dataobject

  Section-specific start/end times. Keys are arbitrary identifiers; values are `ChildEventData` objects.

• location_addressstring

  Physical address of the event's location.

• time_zone_editedstring

  Time zone for event creation/editing (IANA Time Zone Database or Rails TimeZone format, e.g., 'America/New_York').

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestringObligatorio

  The type of communication channel to create.

• tokenstring

  A registration ID, device token, or equivalent. This is required if 'type' is 'push' and is provided by a push notification service when an app registers.

• addressstringObligatorio

  The address of the communication channel. For 'email' type, this is an email address. For 'sms' type, this is a phone number in E.164 format (e.g., +15551234567).

• user_idstringObligatorio

  The ID of the Canvas user for whom this communication channel will be created.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idstringObligatorio

  ID of the user initiating the share; 'self' can be used for the authenticated user.

• content_idintegerObligatorio

  Unique numerical identifier of the content item to be shared.

• content_typestringObligatorioenum

  Type of content being shared.

  assignmentdiscussion_topicpagequizmodulemodule_item
• receiver_idsstring[]Obligatorio

  List of unique Canvas user IDs for recipients; must not be empty.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystringObligatorio

  The content of the message to be sent.

• modestringenum

  Determines whether messages will be created/sent synchronously or asynchronously. 'sync' means the action waits for completion, 'async' means it returns immediately. Defaults to 'sync'.

  syncasync
• scopestringenum

  Filters conversations by a specific scope (e.g., 'unread', 'starred', 'archived') to potentially reuse an existing conversation matching this scope and other filter criteria. Affects which conversation is returned or updated if not forcing new.

  unreadstarredarchived
• filterstring[]

  Array of conversation IDs or user IDs. Used with `scope` and `filter_mode` to find an existing conversation to reuse. If a match is found and `force_new` is not true, that conversation is used/updated instead of creating a new one.

• subjectstring

  The subject of the conversation. Maximum length is 255 characters.

• force_newboolean

  If true, forces the creation of a new conversation, even if an existing private conversation with the same recipients, scope, and filters is found. If false or not provided, an existing matching conversation may be reused.

• recipientsstring[]Obligatorio

  Array of recipient IDs. User IDs are numeric strings. Course/group IDs are strings prefixed with 'course_' or 'group_' respectively, followed by the ID (e.g., 'course_123', 'group_456').

• filter_modestringenum

  Specifies how the `filter` criteria are combined ('and', 'or'). Used in conjunction with `scope` and `filter` to identify an existing conversation for reuse. 'default' typically implies 'and'.

  andordefault
• context_codestring

  The course or group ID that provides context for this conversation (e.g., 'course_123', 'group_456'). This associates the conversation with a specific course or group.

• attachment_idsstring[]

  Array of attachment IDs from the sender's conversation attachments folder. These are IDs of files previously uploaded by the sender.

• media_comment_idstring

  Media comment ID of an audio or video file to be associated with this message. This ID refers to a media object previously created.

• group_conversationboolean

  If true, a single group conversation is created with all recipients. If false or not provided, individual private conversations will be created with each recipient. Ignored if `force_new` is true and a new conversation is created.

• media_comment_typestringenum

  Type of the associated media file. Must be 'audio' or 'video' if `media_comment_id` is provided.

  audiovideo

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The name of the course. If omitted, Canvas will default to 'Unnamed Course'.

• offerboolean

  If true, the course will be made available to students (published) immediately upon creation. If false, it remains unpublished and hidden from students until explicitly published.

• end_atstring

  The end date and time for the course, in ISO8601 format (e.g., '2024-12-15T23:59:59Z'). If omitted, the course will not have a specific end date.

• licensestringenum

  Specifies the license for the course content.

  privatecc_by_nc_ndcc_by_nc_sacc_by_nccc_by_ndcc_by_sacc_bypublic_domain
• term_idstring

  The unique identifier of the academic term (e.g., Fall 2024) to associate this course with.

• start_atstring

  The start date and time for the course, in ISO8601 format (e.g., '2024-09-01T00:00:00Z'). If omitted, the course will not have a specific start date.

• enroll_meboolean

  If true, the user making this API request will be automatically enrolled in the newly created course as a teacher.

• is_publicboolean

  If set to true, the course will be publicly visible to both authenticated and unauthenticated users. Otherwise, visibility is restricted.

• time_zonestring

  The time zone for the course, used for displaying deadlines and scheduling events. Accepts IANA time zone names (e.g., 'America/New_York') or Rails time zone names.

• account_idstringObligatorio

  The ID of the account in which the course will be created. This is a mandatory field.

• course_codestring

  The course code or abbreviation (e.g., 'CS101', 'HIST-202').

• default_viewstringenum

  The default landing page for the course after a user navigates to it.

  feedwikimodulessyllabusassignments
• course_formatstringenum

  The delivery format of the course.

  on_campusonlineblended
• post_manuallyboolean

  If true, all grades for assignments must be manually posted by an instructor before they are visible to students. This enables the 'manual grading policy' feature for the course.

• sis_course_idstring

  A unique identifier for the course from an external Student Information System (SIS). Used for synchronization.

• syllabus_bodystring

  The HTML content for the course's syllabus page. This can include text, images, links, and other rich content.

• integration_idstring

  A unique identifier for the course from an external integration or third-party tool.

• open_enrollmentboolean

  If set to true, the course allows open enrollment, meaning users can join without an invitation or instructor approval.

• public_syllabusboolean

  If set to true, the course syllabus will be publicly visible to all users, including those not logged in.

• self_enrollmentboolean

  If set to true, students can self-enroll in the course, potentially using a join code or public course listing.

• hide_final_gradesboolean

  If set to true, the totals in the student grades summary page will be hidden from students, preventing them from seeing their final calculated grade.

• public_descriptionstring

  A short, publicly visible description or summary of the course.

• allow_wiki_commentsboolean

  If set to true, course members (students and instructors) will be able to add comments to wiki pages.

• grading_standard_idinteger

  The ID of an existing grading standard to be used for the course. This defines the mapping from percentage scores to letter grades (e.g., A, B, C).

• grade_passback_settingstring

  Configures how grades are passed back to an external system, typically an SIS. Valid options are 'nightly_sync' (grades sync daily), 'disabled' (no grade passback), or an empty string (often defaults to 'disabled').

• enable_sis_reactivationboolean

  If true, and a course with the same `sis_course_id` was previously deleted, this action will attempt to reactivate and update that course instead of creating a new one. Requires `sis_course_id` to be provided.

• is_public_to_auth_usersboolean

  If set to true, the course is publicly visible only to authenticated users on the platform.

• public_syllabus_to_authboolean

  If set to true, the course syllabus will be visible to any authenticated user on the platform, even if they are not enrolled.

• allow_student_wiki_editsboolean

  If set to true, students enrolled in the course will be able to edit and contribute to course wiki pages.

• apply_assignment_group_weightsboolean

  If set to true, the final grade for the course will be calculated based on weighted assignment groups (e.g., Homework 30%, Exams 70%).

• allow_student_forum_attachmentsboolean

  If set to true, students can attach files to their posts in course discussion forums and announcements.

• restrict_enrollments_to_course_datesboolean

  If set to true, student enrollments will be active only between the course's `start_at` and `end_at` dates. Access outside these dates may be restricted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• messagestringObligatorio

  The content of the discussion entry. Supports HTML formatting.

• topic_idintegerObligatorio

  The unique identifier of the discussion topic within the course.

• course_idintegerObligatorio

  The unique identifier of the Canvas course.

• attachment_idsinteger[]

  A list of file attachment IDs to include with the new entry, if any.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestringObligatorio

  The title of the new discussion topic.

• pinnedboolean

  Set to `true` to pin the topic, listing it in a 'Pinned Discussions' section for higher visibility. Defaults to `false`.

• lock_atstringdate-time

  The datetime (ISO 8601 format) when the topic should be automatically locked, preventing further replies. If omitted, the topic will not automatically lock.

• messagestring

  The main content/message of the discussion topic. While not explicitly stated for this API endpoint, Canvas discussions generally support HTML for rich content formatting.

• course_idintegerObligatorio

  The unique identifier for the course where the discussion topic will be created.

• publishedboolean

  Set to `true` to publish the topic immediately, or `false` to save it as a draft. Defaults to `false` if not provided, creating a draft.

• allow_ratingboolean

  Set to `true` to allow users to rate entries in this topic. Defaults to `false`.

• position_afterstring

  The ID of another discussion topic within the same course. If provided, this new topic will be positioned immediately after the specified topic in the discussion list.

• sort_by_ratingboolean

  If `allow_rating` is `true`, set this to `true` to sort discussion entries by their ratings. Defaults to `false`.

• delayed_post_atstringdate-time

  The datetime (ISO 8601 format) when the topic should be automatically published. If set, `published` should ideally be `false` or omitted.

• discussion_typestring

  The type of discussion. Accepted values: 'side_comment' (allows replies to any message), 'threaded' (allows threaded replies), 'not_threaded' (linear discussion). Defaults to 'side_comment' if not specified.

• is_announcementboolean

  Set to `true` to mark this topic as an announcement. Announcements may appear in a special section or have different notification behavior. Defaults to `false`.

• podcast_enabledboolean

  Set to `true` to enable an associated podcast feed for this topic. Defaults to `false`.

• group_category_idinteger

  The ID of a group category within the course. If provided, the discussion topic will be associated with this group category, potentially creating group-specific discussions or restricting access. Example: A group discussion.

• specific_sectionsstring

  A comma-separated string of section IDs to which this discussion topic should be restricted. If omitted, or an empty string is provided, the topic is available to all sections in the course.

• require_initial_postboolean

  Set to `true` to require users to make an initial post before they can view other replies in the topic. Defaults to `false`.

• only_graders_can_rateboolean

  If `allow_rating` is `true`, set this to `true` to restrict rating privileges to graders only. Defaults to `false` (meaning any user can rate if `allow_rating` is true).

• podcast_has_student_postsboolean

  If `podcast_enabled` is `true`, set this to `true` to include student posts in the podcast feed. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• end_atstring

  ISO8601 end date/time for enrollment. If unspecified, may follow course/term dates or be indefinite.

• notifyboolean

  If true, sends notification to user. Default notification behavior varies if null/false.

• role_idinteger

  ID of a custom course-level role, potentially overriding `enrollment_type`.

• user_idstringObligatorio

  The ID of the user to be enrolled in the course.

• start_atstring

  ISO8601 start date/time for enrollment. If unspecified, may start immediately or align with course/term settings.

• course_idintegerObligatorio

  The ID of the course in which to enroll the user.

• sis_user_idstring

  SIS (Student Information System) ID for the user; an alternative identifier.

• self_enrolledboolean

  True if self-initiated enrollment, typically with `self_enrollment_code`.

• integration_idstring

  External unique identifier for linking with third-party systems.

• enrollment_typestringenum

  Enrollment type determining role/permissions. Canvas defaults to 'StudentEnrollment' if unspecified.

  StudentEnrollmentTeacherEnrollmentTaEnrollmentObserverEnrollmentDesignerEnrollment
• enrollment_statestringenum

  State of enrollment: 'active', 'invited' (requires user acceptance), or 'inactive'.

  activeinvitedinactive
• course_section_idinteger

  ID of a specific course section for enrollment. If omitted, user enrolls in the course generally.

• associated_user_idinteger

  For 'ObserverEnrollment', the ID of the student to be observed.

• self_enrollment_codestring

  Code for self-enrollment if `self_enrolled` is true.

• limit_privileges_to_course_sectionboolean

  If true, confines user access to `course_section_id` (requires `course_section_id` to be set).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the context entity (e.g., course ID, user ID, group ID, folder ID, or account ID) where the folder will be created.

• namestringObligatorio

  The desired name for the new folder.

• hiddenboolean

  A boolean flag indicating whether the folder should be hidden upon creation. A hidden folder is typically not visible in the standard folder listings.

• lockedboolean

  A boolean flag indicating whether the folder should be locked upon creation. A locked folder typically restricts access or modifications.

• lock_atstring

  The date and time at which the folder should become locked, specified in ISO 8601 format (e.g., '2011-10-21T18:48Z').

• positioninteger

  An integer value to explicitly set the sort order or position of the folder among its siblings.

• unlock_atstring

  The date and time at which the folder should become unlocked, specified in ISO 8601 format (e.g., '2011-10-21T18:48Z').

• context_typestringObligatorioenum

  Specifies the context in which to create the folder. Valid contexts are 'courses', 'users', 'groups', 'folders', or 'accounts'.

  coursesusersgroupsfoldersaccounts
• parent_folder_idstring

  The ID of an existing parent folder within the specified context. If provided, the new folder will be created inside this parent folder. Cannot be used simultaneously with `parent_folder_path`.

• parent_folder_pathstring

  The full path to an existing parent folder within the specified context (e.g., 'course files/week 1/assignments'). If provided, the new folder will be created inside this parent folder. Cannot be used simultaneously with `parent_folder_id`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new module.

• positioninteger

  1-based position in the course's module list.

• course_idstringObligatorio

  ID of the course for the new module.

• unlock_atstring

  ISO 8601 datetime for module availability to students. If omitted, availability follows course settings.

• publish_final_gradeboolean

  If true, automatically publishes the student's final course grade upon module completion.

• prerequisite_module_idsstring[]

  List of module IDs that are prerequisites for accessing this module.

• require_sequential_progressboolean

  If true, students must complete items sequentially; if false, any order is allowed.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  HTML content of the new page. Must be valid HTML.

• titlestringObligatorio

  Title for the new wiki page.

• course_idintegerObligatorio

  Unique identifier for the course.

• publishedboolean

  Publish the page upon creation. Defaults to false (draft).

• front_pageboolean

  Set as the front page for the course; page must also be published. Defaults to false.

• editing_rolesstring

  Comma-separated string of roles allowed to edit: 'teachers', 'students', 'members', 'public'. Defaults to 'teachers'.

• notify_of_updateboolean

  Notify users of changes to this page. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestringObligatorio

  The title of the quiz.

• due_atstring

  The date and time (ISO 8601 format) by which the quiz should be submitted.

• lock_atstring

  The date and time (ISO 8601 format) after which students can no longer submit the quiz.

• course_idstringObligatorio

  The ID of the course where the quiz will be created.

• ip_filterstring

  An optional comma-separated list of IP addresses or CIDR ranges (e.g., '192.168.1.0/24', '203.0.113.42') to restrict quiz access.

• publishedboolean

  If true, the quiz will be published and visible to students according to availability dates and override settings. Default is typically false for new quizzes.

• quiz_typestringenum

  Specifies the type of quiz.

  practice_quizassignmentgraded_surveysurvey
• unlock_atstring

  The date and time (ISO 8601 format) when the quiz becomes available for students to take.

• time_limitinteger

  The time limit for the quiz in minutes. Use null or omit for no time limit.

• access_codestring

  An optional password students must enter to start the quiz.

• descriptionstring

  A textual description of the quiz content and instructions.

• cant_go_backboolean

  If true and `one_question_at_a_time` is also true, students cannot return to previous questions after submitting an answer for the current question. Default is false.

• hide_resultsstringenum

  Controls when students can see their quiz results. If null or omitted, results are shown immediately after submission.

  alwaysuntil_after_last_attempt
• scoring_policystringenum

  If multiple attempts are allowed, this determines which attempt's score is recorded.

  keep_highestkeep_latest
• shuffle_answersboolean

  If true, the order of answers for questions will be randomized for each student. Default is typically false.

• allowed_attemptsinteger

  The number of times a student is allowed to take the quiz. Use -1 for unlimited attempts. Omit for course/quiz default.

• one_time_resultsboolean

  If true and `hide_results` is also set (not null), students can only view their results once, immediately after submitting the quiz. Has no effect if `hide_results` is null. Default is false.

• assignment_group_idinteger

  The ID of the assignment group to associate the quiz with. This is applicable only if the quiz is graded (e.g., 'assignment' or 'graded_survey' type).

• show_correct_answersboolean

  If true, students will be able to see the correct answers when viewing their results (subject to other settings like `show_correct_answers_at` and `hide_correct_answers_at`). Default is typically true.

• one_question_at_a_timeboolean

  If true, students will see one question at a time and must navigate sequentially. Default is false.

• hide_correct_answers_atstring

  The date and time (ISO 8601 format) after which correct answers will be hidden from students. Requires `show_correct_answers` to be true.

• show_correct_answers_atstring

  The date and time (ISO 8601 format) when correct answers will become visible to students. Requires `show_correct_answers` to be true.

• only_visible_to_overridesboolean

  If true, the quiz is hidden from the general student population and only accessible to students with specific assignment overrides. Default is false.

• show_correct_answers_last_attemptboolean

  If true, correct answers will only be shown to students after their last allowed attempt. Requires `show_correct_answers` to be true.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• answersobject[]

  Answer objects, if provided. Structure is critical and must align with `question_type`. Refer to Canvas API documentation for format details per type.

• quiz_idintegerObligatorio

  Identifier of the quiz to add the question to.

• positioninteger

  1-based display order in the quiz; defaults to end if omitted.

• course_idintegerObligatorio

  Identifier of the course containing the quiz.

• question_namestringObligatorio

  Descriptive name for identification, especially in question banks.

• question_textstringObligatorio

  Main question content, presented to the student; supports HTML.

• question_typestringObligatorioenum

  Question format and answer options. See `QuestionType` enum.

  calculated_questionessay_questionfile_upload_questionfill_in_multiple_blanks_questionmatching_questionmultiple_answers_questionmultiple_choice_questionmultiple_dropdowns_questionnumerical_questionshort_answer_questiontext_only_questiontrue_false_question
• quiz_group_idinteger

  ID of an existing quiz group for this question; for organization within the quiz.

• points_possibleinteger

  Maximum points for a correct answer.

• correct_commentsstring

  Feedback (text/HTML) for a correct answer.

• neutral_commentsstring

  Feedback (text/HTML) regardless of answer correctness.

• incorrect_commentsstring

  Feedback (text/HTML) for an incorrect answer.

• text_after_answersstring

  Additional text/HTML displayed post-submission (e.g., explanations).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cancel_reasonstring

  An optional reason for deleting the appointment group.

• appointment_group_idstringObligatorio

  The unique identifier of the appointment group to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  The unique identifier of the course to which the assignment belongs.

• assignment_idintegerObligatorio

  The unique identifier of the assignment to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the folder to be deleted.

• forceboolean

  If `true`, deletes the folder even if it contains items. If `false` (default), the folder must be empty for deletion.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• quiz_idstringObligatorio

  The unique identifier for the quiz to be deleted.

• course_idstringObligatorio

  The unique identifier for the course from which the quiz will be deleted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idintegerObligatorio

  Unique Canvas account ID (often a department or sub-account) for which to retrieve current grade analytics.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• term_idintegerObligatorio

  Unique identifier for the academic term to request grade data for.

• account_idintegerObligatorio

  Unique identifier for the Canvas account to retrieve analytics data from.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new name for the assignment.

• due_atstring

  The new due date for the assignment, formatted in ISO 8601 (e.g., '2025-10-21T18:48:00Z').

• positioninteger

  The new position of this assignment within its assignment group when displayed in lists. Lower numbers appear first.

• course_idintegerObligatorio

  The unique identifier for the course containing the assignment.

• publishedboolean

  Whether the assignment should be published. Set to `True` to publish, `False` to unpublish. If not provided, the existing published status may be retained or it might default to `False` depending on the API's behavior for partial updates.

• unlock_atstring

  The new date when the assignment becomes available to students, formatted in ISO 8601 (e.g., '2025-10-21T18:48:00Z').

• descriptionstring

  The new HTML content for the assignment's description.

• grading_typestring

  The new grading type for the assignment. Supported types include 'pass_fail', 'percent', 'letter_grade', 'gpa_scale', 'points', 'not_graded'.

• assignment_idintegerObligatorio

  The unique identifier for the assignment to be edited.

• integration_idstring

  The new unique identifier for the assignment from a third-party integration (e.g., an external tool).

• points_possibleinteger

  The new maximum number of points possible for the assignment.

• allowed_attemptsinteger

  The new number of submission attempts allowed for the assignment. Use -1 for unlimited attempts.

• submission_typesstring[]

  A list of new submission types supported for the assignment. Valid types include 'online_quiz', 'none', 'on_paper', 'discussion_topic', 'external_tool', 'online_upload', 'online_text_entry', 'online_url'.

• allowed_extensionsstring[]

  File extensions (e.g., 'pdf', 'docx') allowed if `submission_types` includes 'online_upload'.

• assignment_group_idinteger

  The unique identifier of the assignment group to which this assignment should be moved or associated.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  New title for the quiz. If None, the title will not be updated.

• due_atstring

  Due date/time for the quiz (ISO 8601 format). No update if None.

• lock_atstring

  When students can no longer take the quiz (ISO 8601 format). No update if None.

• quiz_idstringObligatorio

  Identifier for the quiz to be updated.

• course_idstringObligatorio

  Identifier for the course in which the quiz resides.

• ip_filterstring

  A comma-separated list of IP addresses or CIDR netmasks (e.g., '192.168.1.1/24') that are allowed to access the quiz. If None, this setting will not be updated.

• publishedboolean

  If true, the quiz is published and visible to students. If false, it is unpublished. If None, the publication status will not be updated.

• quiz_typestringenum

  The type of the quiz. If None, the type will not be updated.

  practice_quizassignmentgraded_surveysurvey
• unlock_atstring

  When the quiz becomes available (ISO 8601 format). No update if None.

• time_limitinteger

  Time limit for the quiz in minutes. Use null or omit to remove an existing time limit, effectively setting no time limit. If None, the time limit will not be updated.

• access_codestring

  A password to restrict access to the quiz. Setting this to an empty string will remove an existing access code. If None, the access code will not be updated.

• descriptionstring

  New HTML description for the quiz. If None, the description will not be updated.

• cant_go_backboolean

  If true, students cannot go back to previous questions after answering them (only applicable if `one_question_at_a_time` is true). If None, this setting will not be updated.

• hide_resultsstringenum

  Specifies when results should be hidden from students. Use 'always' to hide results completely or 'until_after_last_attempt' to hide them until the student has completed their final attempt. If None, this setting will not be updated.

  alwaysuntil_after_last_attempt
• scoring_policystringenum

  Determines which score is kept if multiple attempts are allowed ('keep_highest' or 'keep_latest'). If None, this setting will not be updated.

  keep_highestkeep_latest
• shuffle_answersboolean

  If true, answers to quiz questions will be shuffled for each student. If None, this setting will not be updated.

• allowed_attemptsinteger

  Number of attempts a student is allowed to take for the quiz. Use -1 for unlimited attempts. If None, this setting will not be updated.

• notify_of_updateboolean

  If true, sends notifications to users about the quiz update.

• one_time_resultsboolean

  If true, students can only view their quiz results once (this option is disabled if `allowed_attempts` > 1). If None, this setting will not be updated.

• assignment_group_idinteger

  The ID of the assignment group to associate with the quiz. This is relevant for graded quizzes (e.g., 'assignment', 'graded_survey'). If None, the assignment group will not be updated.

• show_correct_answersboolean

  If true, students can see the correct answers after submitting the quiz (subject to other restrictions like `hide_results`, `show_correct_answers_at`, `hide_correct_answers_at`). If None, this setting will not be updated.

• one_question_at_a_timeboolean

  If true, students will see one question at a time. If None, this setting will not be updated.

• hide_correct_answers_atstring

  When correct answers will be hidden (ISO 8601 format). No update if None.

• show_correct_answers_atstring

  When correct answers become visible (ISO 8601 format). No update if None.

• only_visible_to_overridesboolean

  If true, the quiz is only visible to students with specific overridden due dates. If None, this setting will not be updated.

• show_correct_answers_last_attemptboolean

  If true, correct answers will only be shown after the student's final attempt for quizzes that allow multiple attempts. If None, this setting will not be updated.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  The unique identifier for the course whose content is to be exported.

• export_typestringObligatorioenum

  Format for the exported content.

  common_cartridgeqtizip
• skip_notificationsboolean

  If true, suppresses progress notifications to the initiating user.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number to fetch (1-indexed). Use to get results beyond the first page.

• user_idinteger

  Canvas user ID, required when `get_user_courses` is true.

• per_pageinteger

  Number of items to return per page. Maximum is typically 100. Higher values fetch more data in a single request.

• course_idinteger

  Canvas course ID, required if fetching course-specific data (e.g., assignments, files, users for a course).

• get_filesboolean

  Fetches files for a specific course (requires `course_id`).

• get_pagesboolean

  Fetches pages for a specific course (requires `course_id`).

• get_usersboolean

  Fetches users for an account (requires `account_id`) or a course (requires `course_id`), optionally filter course users by `search_term`.

• account_idinteger

  Canvas account ID (e.g., numerical ID or 'self'), required when `get_users` is true for an account. Can be found via `get_accounts` or use 'self'.

• get_coursesboolean

  Fetches courses for the current user, optionally filtered by `enrollment_type` and `enrollment_state`.

• get_quizzesboolean

  Fetches quizzes for a specific course (requires `course_id`).

• search_termstring

  Search term to filter results when `get_users` (for a course) or `get_discussion_topics` is true.

• get_accountsboolean

  Fetches Canvas accounts accessible to the current user.

• assignment_idinteger

  Canvas assignment ID, required when `get_submissions` is true.

• enrollment_typestring

  Filter for `get_courses` or `get_user_courses` by enrollment type.

• get_assignmentsboolean

  Fetches assignments for a specific course (requires `course_id`).

• get_submissionsboolean

  Fetches submissions for an assignment within a course (requires `course_id` and `assignment_id`).

• enrollment_statestring

  Filter for `get_courses` or `get_user_courses` by enrollment state.

• get_user_coursesboolean

  Fetches courses for a specific user (requires `user_id`), optionally filtered by `enrollment_type` and `enrollment_state`.

• only_announcementsboolean

  When `get_discussion_topics` is true: if true, retrieves only announcements; if false, retrieves only discussion topics; if not specified, retrieves discussion topics (defaults to false).

• get_discussion_topicsboolean

  Fetches discussion topics for a specific course (requires `course_id`). Use `only_announcements` to control whether to fetch announcements only (true), discussion topics only (false), or use default behavior (None). Can be filtered by `search_term`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• per_pageinteger

  The number of assignments to return per page.

• course_idintegerObligatorio

  The unique identifier of the course from which to retrieve assignments.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for pagination (1-indexed).

• sortstring

  Field to sort users by (e.g., 'username', 'email', 'sis_id', 'integration_id', 'last_login').

• orderstring

  Sort direction: 'asc' (ascending) or 'desc' (descending).

• per_pageinteger

  Number of users per page (max 100).

• account_idstringObligatorio

  Unique identifier for the Canvas account; use 'self' for the current user's root account.

• search_termstring

  Filter users by name, username, or email.

• enrollment_typestring[]

  Filter users by enrollment type (e.g., 'student', 'teacher', 'ta', 'observer', 'designer').

• include_deleted_usersboolean

  If true, include users marked as deleted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  Unique identifier for the course containing the assignment.

• assignment_idintegerObligatorio

  Unique identifier for the assignment to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  Unique identifier for the course.

• assignment_idstringObligatorio

  Unique identifier for the assignment.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  The unique numerical identifier of the Canvas course.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idintegerObligatorio

  Unique identifier for the Canvas account.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idintegerObligatorio

  The unique identifier for the Canvas account (which may represent a department) for which to retrieve current statistics.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idintegerObligatorio

  Unique identifier of the Canvas account.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• term_idintegerObligatorio

  The unique identifier for the academic term.

• account_idintegerObligatorio

  The unique identifier for the Canvas account (e.g., a specific department).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier for the enrollment object to be retrieved.

• account_idstringObligatorio

  The unique identifier for the account in which the enrollment exists. Often 'self' can be used for the current user's account.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  The unique identifier for the course for which to retrieve the gradebook history days.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  The unique identifier for the Canvas course.

• url_or_idstringObligatorio

  The URL (e.g., 'my-first-page') or the numeric ID of the page. If a page URL might be identical to another page's numeric ID, prefix the ID with 'page_id:' (e.g., 'page_id:5678').

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• includestring[]

  Optional. Specifies related resources like 'submission', 'quiz', or 'user' to include with each submission. If omitted or empty, minimal data is returned.

• quiz_idstringObligatorio

  The unique ID of the quiz.

• course_idstringObligatorio

  The unique ID of the course.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idintegerObligatorio

  Unique identifier of the specific report instance, usually obtained when report generation is initiated.

• reportstringObligatorio

  Type or name of the report, typically a predefined report type within Canvas.

• account_idintegerObligatorio

  Unique identifier for the Canvas account.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• includestring[]

  Specifies optional additional data to include with the course response. Allowed values: 'needs_grading_count', 'syllabus_body', 'public_description', 'total_scores', 'current_grading_period_scores', 'term', 'account', 'course_progress', 'sections', 'storage_quota_used_mb', 'total_students', 'passback_status', 'favorites', 'teachers', 'observed_users', 'all_courses', 'permissions', 'course_image', 'banner_image', 'concluded', 'lti_context_id', 'post_manually'.

• course_idintegerObligatorio

  The unique identifier for the Canvas course to retrieve.

• teacher_limitinteger

  If 'teachers' is in `include`, limits the number of teacher enrollments returned; API default applies otherwise.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• includestring[]

  Additional related resources to include with the submission. Common values: 'submission_history', 'submission_comments', 'rubric_assessment', 'assignment', 'course', 'user', 'group', 'visibility', 'read_status'.

• user_idintegerObligatorio

  ID of the user whose submission is being retrieved, or 'self' for the current authenticated user.

• course_idintegerObligatorio

  ID of the course.

• assignment_idintegerObligatorio

  ID of the assignment.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idstringObligatorio

  ID of the user (student) whose submission files are sought.

• course_idstringObligatorio

  ID of the Canvas course.

• assignment_idstringObligatorio

  ID of the assignment.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  The unique identifier for the course.

• student_idintegerObligatorio

  The unique identifier for the student.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idstringObligatorio

  The unique identifier of the user whose course progress is being requested. Use 'self' to fetch progress for the currently authenticated user.

• course_idintegerObligatorio

  The unique numerical identifier of the course for which progress is being requested.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  The unique identifier of the course for which to retrieve analytics.

• student_idintegerObligatorio

  The unique identifier of the student for whom to retrieve analytics.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  Unique identifier for the user.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• excuseboolean

  If true, marks submission 'excused'. Excused assignments typically don't affect total grade.

• attemptinteger

  Specific attempt number for the comment, if multiple attempts allowed.

• stickerstring

  The name of a sticker to apply to the submission (e.g., 'apple', 'star').

• user_idintegerObligatorio

  The unique identifier for the user (student) whose submission is being addressed.

• course_idintegerObligatorio

  The unique identifier for the course.

• posted_gradestring

  Grade/score to assign (e.g., '95', 'A-'). Updates 'score' and 'grade' in Canvas.

• text_commentstring

  A textual comment to add to the submission.

• assignment_idintegerObligatorio

  The unique identifier for the assignment within the course.

• group_commentboolean

  If true, comment is visible to student's group (if a group assignment).

• media_comment_idstring

  Identifier for a pre-existing media comment. Obtaining this ID may require UI interaction due to Canvas API limitations for its management.

• late_policy_statusstring

  Sets late policy status. If omitted, existing status is unchanged.

• media_comment_typestring

  Type of media comment (e.g., 'audio', 'video'), relevant if `media_comment_id` is provided.

• seconds_late_overrideinteger

  Overrides calculated lateness in seconds; used with `late_policy_status` or for manual adjustment.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier of the Canvas course for which to list folders. This ID must correspond to an existing course.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scopestring

  Determines the scope of appointment groups to retrieve. For example, 'reservable' returns groups the user can sign up for.

• includestring[]

  List of additional data to include with each appointment group. Possible values: 'appointments', 'child_events', 'participant_count', 'reserved_times', 'all_context_codes'.

• context_codesstring[]

  List of context codes (e.g., 'course_123' or 'group_456') to filter appointment groups by specific courses or groups. If omitted, groups from all relevant contexts are returned.

• include_past_appointmentsboolean

  If true, appointment groups that have already passed will be included in the results. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for pagination (1-indexed). Use to get results beyond the first page.

• groupedboolean

  If set to true, and the assignment is a group assignment, the submissions will be grouped by student group. Otherwise, submissions are returned ungrouped. Defaults to false if not provided.

• includestring[]

  A list of optional related resources to include in the response for each submission. Common values include 'submission_history', 'submission_comments', 'user', and 'assignment'.

• per_pageinteger

  Number of submissions to return per page (max 100). If omitted, Canvas default (10) is used. Set to a higher value (e.g., 100) to get more submissions.

• course_idintegerObligatorio

  The unique identifier of the course.

• assignment_idintegerObligatorio

  The unique identifier of the assignment.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idintegerObligatorio

  The unique identifier for the Canvas account for which to list available reports. This ID can typically be found in the Canvas URL or account settings.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestring

  Type of calendar item to filter by. Use 'event' for general calendar events or 'assignment' for assignments.

• undatedboolean

  If true, only undated events will be returned. This filter is ignored if 'all_events' is true.

• user_idintegerObligatorio

  The unique identifier for the Canvas user whose calendar events are to be listed.

• end_datestring

  The end date for filtering events, in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DD'). Events occurring on or before this date will be returned. This filter is ignored if 'all_events' is true.

• excludesstring[]

  Assignment attributes to exclude (e.g., 'description', 'html_url') if items are assignments. No effect on non-assignment events.

• includesstring[]

  Optional related resources to include in the response (e.g., 'submission', 'assignment_visibility'). E.g., 'submission' adds submission data for assignments.

• all_eventsboolean

  If true, returns all calendar events for the user, overriding 'start_date', 'end_date', and 'undated' filters.

• start_datestring

  The start date for filtering events, in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DD'). Events occurring on or after this date will be returned. This filter is ignored if 'all_events' is true.

• blackout_dateboolean

  If true, retrieves only 'blackout dates' (e.g., dates when a course might be unavailable).

• context_codesstring[]

  Context codes (e.g., 'course_123', 'group_456', 'user_self') to filter events by. If omitted, events from all contexts visible to the user are returned.

• important_datesboolean

  If true, retrieves only events marked 'important_dates' (e.g., course announcements with specific dates).

• submission_typesstring[]

  Submission types (e.g., 'online_quiz', 'on_paper') to filter by if item is an assignment. No effect if 'type' is not 'assignment'.

• exclude_submission_typesstring[]

  Submission types to exclude if item is an assignment. No effect if 'type' is not 'assignment'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idstring

  Identifier for the user whose messages are listed. Defaults to the authenticated user if omitted.

• end_timestring

  End of the time filter (inclusive), as an ISO 8601 timestamp. Includes messages sent on or before this time.

• start_timestring

  Start of the time filter (inclusive), as an ISO 8601 timestamp. Includes messages sent on or after this time.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idstringObligatorio

  The ID of the user for whom to list communication channels. This can be the numeric ID or the SIS User ID.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  The unique identifier for the course.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• per_pageinteger

  Number of courses to return per page. If omitted, Canvas default (10) is used. Set to a higher value (e.g., 100) to get more courses.

• enrollment_typestring

  Filters courses by the user's enrollment type. If omitted, courses are not filtered by enrollment type.

• enrollment_statestring

  Filters courses by the enrollment state. If omitted, courses are not filtered by enrollment state.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• statestring[]

  Filters courses by specified states (e.g., 'available', 'completed'). All allowed values are defined in the `validate_state` method.

• includestring[]

  Specifies additional details to include for each course (e.g., 'syllabus_body', 'term'). All allowed values are defined in the `validate_include` method.

• user_idintegerObligatorio

  The unique identifier of the user for whom to retrieve the list of courses.

• homeroomboolean

  If true, filters the results to include only homeroom courses. Set to false or omit to include all course types.

• account_idstring

  Filters the results to include only courses associated with the specified account ID.

• enrollment_statestring

  Filters courses by the user's enrollment status (e.g., 'active'). All allowed values are defined in the `validate_enrollment_state` method.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number to fetch (1-indexed). Use to get results beyond the first page.

• sortstringenum

  The field to sort the list of users by. Results are sorted in ascending order.

  usernamelast_loginemailsis_id
• includestring[]

  Specifies additional details to include for each user in the response (e.g., 'enrollments', 'avatar_url').

• user_idstring

  If provided, the response will be paginated to the page where this specific user ID appears. Useful for finding a user within a large list.

• per_pageinteger

  Number of users to return per page (max 100). Higher values fetch more data in a single request.

• user_idsinteger[]

  A list of user IDs to filter the results. Only users whose IDs are in this list will be returned.

• course_idstringObligatorio

  The unique identifier for the Canvas course from which to list users.

• search_termstring

  A partial name or full ID to filter users. If provided, only users matching the search term will be returned.

• enrollment_rolestring

  Deprecated: Filters users by a specific course-level role name. Use `enrollment_role_id` instead for better precision.

• enrollment_typestring[]

  Filters the list to include only users with the specified enrollment types (e.g., 'student', 'teacher').

• enrollment_statestring[]

  Filters the list to include only users with the specified enrollment states (e.g., 'active', 'invited').

• enrollment_role_idinteger

  Filters the list to include only users enrolled with the specified course-level role ID.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number to retrieve (pagination).

• per_pageinteger

  Number of entries to return per page (pagination).

• topic_idintegerObligatorio

  The unique identifier of the discussion topic.

• course_idintegerObligatorio

  The unique identifier of the course containing the discussion topic.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scopestring

  Filters topics by a specific state. Only one state can be specified. Valid options: 'locked', 'unlocked', 'pinned', 'unpinned'.

• includestring[]

  Specifies additional data to return for each discussion topic. Valid options: 'all_dates', 'sections', 'sections_user_count', 'overrides'. Multiple options can be provided as a list of strings.

• order_bystring

  The criteria for ordering discussion topics. Defaults to 'position' if not specified. Valid options: 'position', 'recent_activity', 'title'.

• course_idintegerObligatorio

  The unique identifier of the course for which to list discussion topics.

• filter_bystring

  Filters topics based on a characteristic, typically read status. Use 'unread' to get only unread topics. Valid options: 'all', 'unread'.

• search_termstring

  A search string to match against discussion topic titles. Returns topics with partially matching titles.

• only_announcementsboolean

  If true, retrieves only announcements; otherwise, retrieves discussion topics. Defaults to false.

• exclude_context_module_locked_topicsboolean

  If true, and the requester is a student, excludes topics that are locked by module progression. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  The unique Canvas identifier for the course whose files are to be listed.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• folder_idstringObligatorio

  ID of the parent folder for which to list direct sub-folders.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• sortstring

  The field to sort the list of pages by. Common options include 'created_at', 'updated_at', or 'title'.

• orderstring

  The order in which to sort the results. Use 'asc' for ascending order or 'desc' for descending order.

• course_idintegerObligatorio

  The unique identifier for the course for which to list pages.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  The page number for paginated results, starting from 1. If not specified, the first page is returned.

• per_pageinteger

  The number of quizzes to return per page for paginated results. If not specified, a default number (e.g., 10) set by Canvas will be used.

• course_idstringObligatorio

  The unique identifier of the course from which to list quizzes.

• search_termstring

  A partial title to filter quizzes. Only quizzes whose titles contain this term will be returned.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idstringObligatorio

  The unique identifier of the user whose sent content shares are to be retrieved. This can be the numeric Canvas user ID or a SIS ID prefixed with 'sis_user_id:'. Use 'self' to represent the currently authenticated user.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• datestringObligatorio

  The specific date for which to retrieve submission history, in 'YYYY-MM-DD' format. This refers to the date the grading event occurred.

• course_idintegerObligatorio

  The unique identifier for the course.

• grader_idintegerObligatorio

  The unique identifier for the grader whose grading history is to be viewed.

• assignment_idintegerObligatorio

  The unique identifier for the assignment.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  The unique identifier for the Canvas course from which to retrieve submissions.

• student_idsstring[]

  List of student identifiers to filter submissions. Accepts Canvas user IDs, SIS user IDs (e.g., 'sis_user_id:S123'), or the special keyword 'all'. If omitted, submissions for the current authenticated user are returned. Students can only retrieve their own submissions. Observers can only retrieve submissions for students they are associated with. The 'all' keyword retrieves submissions for all students in the specified course or section.

• assignment_idsstring[]

  List of assignment identifiers (Canvas assignment IDs) for which to retrieve submissions. If this list is omitted or empty, submissions for all assignments in the course will be returned.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idinteger

  ID of the user (student) to filter submission versions.

• ascendingboolean

  If true, returns submission versions in ascending order by date (oldest first); defaults to descending (newest first).

• course_idintegerObligatorio

  ID of an existing course to fetch submission versions from.

• assignment_idinteger

  ID of the assignment to filter submission versions.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idintegerObligatorio

  The unique identifier of the Canvas account from which to retrieve the list of users.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• messagestringObligatorio

  The body content of the reply to create. Supports HTML formatting.

• entry_idintegerObligatorio

  The unique identifier for the discussion entry to which the reply will be posted.

• topic_idintegerObligatorio

  The unique identifier for the discussion topic within the course.

• course_idintegerObligatorio

  The unique identifier for the Canvas course containing the discussion topic.

• attachment_idsinteger[]

  A list of file attachment IDs to include with the reply, if any.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• term_idstringObligatorio

  The unique identifier of the enrollment term to be retrieved from the specified account.

• account_idstringObligatorio

  The unique identifier for the root account. Important: This must be the ID of a root-level account, not a sub-account, to avoid errors.

Parámetros de salida

• dataobject

  A dictionary containing the detailed information of the retrieved enrollment term.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reportstringObligatorio

  The type or name of the report to start. Use the 'List Available Reports' action or Canvas API documentation to get available report types.

• account_idintegerObligatorio

  The unique identifier for the Canvas account for which the report will be generated.

• parametersobject

  Parameters specific to the chosen report type (e.g., a 'grade_export_csv' might need `courses[course_id]`). Consult 'List Available Reports' or API documentation for parameter details. Omit if none are needed.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idstringObligatorio

  Identifier for the Canvas course containing the file.

• migration_idstringObligatorio

  Identifier for a file reference, typically assigned during content import, used to find its current representation in the course.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  Short title. Omit to keep existing.

• publishboolean

  Set `True` to publish; `False` for draft. Defaults to `False` if omitted.

• descriptionstring

  Detailed description. Omit to keep existing.

• context_codesstring[]

  Codes (e.g., 'course_123') linking to contexts like courses/groups. Omit to keep existing.

• location_namestring

  Location name (e.g., 'Room 301', 'Online Zoom'). Omit to keep existing.

• location_addressstring

  Physical/virtual address for location. Omit to keep existing.

• sub_context_codesstring[]

  Codes (e.g., 'section_abc') for sub-contexts like course sections. Omit to keep existing.

• appointment_group_idstringObligatorio

  Unique identifier of the appointment group to update.

• allow_observer_signupboolean

  `True` allows observer sign-ups, `False` disallows. Omit to keep existing.

• participant_visibilitystringenum

  Participant list visibility ('private' or 'protected'). Omit to keep existing.

  privateprotected
• participants_per_appointmentinteger

  Max participants per slot. Omit to keep existing.

• max_appointments_per_participantinteger

  Max slots a user may book. Omit to keep existing.

• min_appointments_per_participantinteger

  Min slots a user must book. Omit to keep existing.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the course to update.

• namestring

  New name for the course.

• eventstringenum

  Lifecycle action for the course (e.g., 'conclude', 'offer', 'delete').

  claimofferconcludedeleteundelete
• end_atstringdate-time

  New end date in ISO8601 format.

• licensestringenum

  New license for course content, defining usage.

  privatecc_by_nc_ndcc_by_nc_sacc_by_nccc_by_ndcc_by_sacc_bypublic_domain
• term_idinteger

  ID of the academic term to associate with the course.

• start_atstringdate-time

  New start date in ISO8601 format.

• is_publicboolean

  If `true`, course is visible to all users (authenticated and unauthenticated).

• account_idinteger

  The ID of the account to which the course will be reassigned.

• course_codestring

  New course code.

• default_viewstringenum

  Default landing page view when users navigate to the course.

  feedwikimodulessyllabusassignments
• syllabus_bodystring

  HTML content for the course syllabus, replacing existing content.

• open_enrollmentboolean

  If `true`, allows open enrollment where users can self-enroll without approval.

• public_syllabusboolean

  If `true`, syllabus is publicly visible to everyone.

• self_enrollmentboolean

  If `true`, allows users to self-enroll, often via a URL or code.

• public_descriptionstring

  Publicly visible description of course content or objectives.

• allow_wiki_commentsboolean

  If `true`, course members can add comments to wiki pages.

• is_public_to_auth_usersboolean

  If `true`, course is visible only to authenticated users.

• override_sis_stickinessboolean

  If `true`, API updates can override SIS-controlled fields; if `false`, updates to 'sticky' SIS fields are prevented.

• public_syllabus_to_authboolean

  If `true`, syllabus is visible only to authenticated users.

• allow_student_wiki_editsboolean

  If `true`, enrolled students can edit wiki pages.

• allow_student_forum_attachmentsboolean

  If `true`, students can attach files to forum posts.

• restrict_enrollments_to_course_datesboolean

  If `true`, enrollment is restricted to the course's start and end dates.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• course_idintegerObligatorio

  The unique identifier for the course whose settings are to be updated.

• default_due_timestring

  Sets the default due time for new assignments. This time will be pre-selected in the Canvas UI. Does not affect existing assignments. Format: HH:MM:SS (24-hour). Default is '23:59:59'. Use 'inherit' to use the account-level setting.

• hide_final_gradesboolean

  If true, hides the total grades in the student grades summary page.

• conditional_releaseboolean

  If true, enables individual learning paths for students, allowing content to be released based on their performance on assessments or other criteria.

• usage_rights_requiredboolean

  If true, requires copyright and license information to be provided for files before they can be published.

• lock_all_announcementsboolean

  If true, disables comments on all course announcements.

• syllabus_course_summaryboolean

  If true (default), shows the course summary, including a list of assignments and calendar events, on the syllabus page.

• hide_distribution_graphsboolean

  If true, hides grade distribution graphs from students' view.

• allow_final_grade_overrideboolean

  If true, allows instructors to override the final grade for students for a grading period or the entire course.

• restrict_student_past_viewboolean

  If true, restricts students from viewing the course content after the official course end date.

• home_page_announcement_limitinteger

  Specifies the maximum number of announcements to display on the home page when `show_announcements_on_home_page` is enabled. Only applicable if the home page is a Wiki.

• restrict_student_future_viewboolean

  If true, restricts students from viewing the course content before the official course start date.

• allow_student_organized_groupsboolean

  If true, allows students to create and manage their own groups within the course.

• allow_student_discussion_topicsboolean

  If true, allows students to create new discussion topics.

• allow_student_forum_attachmentsboolean

  If true, allows students to attach files to their discussion posts and replies.

• show_announcements_on_home_pageboolean

  If true, displays the most recent course announcements on the course home page. For Wiki home pages, this defaults to five announcements but can be configured via `home_page_announcement_limit`. This setting is ignored by Canvas for Elementary subjects.

• allow_student_discussion_editingboolean

  If true, allows students to edit or delete their own discussion posts and replies.

• allow_student_discussion_reportingboolean

  If true, allows students to report discussion content they deem offensive or inappropriate.

• hide_sections_on_course_users_pageboolean

  If true, prevents students from viewing other students in sections they are not enrolled in on the course users page.

• filter_speed_grader_by_student_groupboolean

  If true, SpeedGrader will be filtered to display students only from the currently selected group.

• allow_student_anonymous_discussion_topicsboolean

  If true, allows students to create discussion topics anonymously.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new display name for the file. If this field is not provided or is null, the file's current name will be preserved.

• file_idstringObligatorio

  The unique identifier of the file to be updated.

• on_duplicatestring

  Defines the action to take if a file with the specified `name` already exists in the target `parent_folder_id`. Valid options are: 'rename' (the uploaded file will be renamed to avoid conflict, e.g., 'filename (1).txt') or 'overwrite' (the existing file will be replaced). If not provided or null, the Canvas API's default behavior for handling duplicates will apply.

• parent_folder_idstring

  ID of the folder to move the file to. Must be an existing folder in the same context as the file's original parent. Ignored if the context lacks folders (e.g., root user files) or if null (file stays in current location).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  New HTML content for the page body. Retains existing if None.

• titlestring

  New title for the page. Retains existing if None.

• course_idstringObligatorio

  Identifier of the course containing the page.

• publishedboolean

  Publish or unpublish the page. Retains existing status if None.

• url_or_idstringObligatorio

  URL (hyphenated string from title) or numeric ID of the page to update.

• front_pageboolean

  Set as course front page (must be published). Retains existing status if None.

• editing_rolesstring

  Comma-separated list of roles ('teachers', 'students', 'members', 'public') allowed to edit. Retains existing if None.

• notify_of_updateboolean

  Notify course participants of the update. Retains existing preference if None.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The unique identifier for the quiz submission to be updated.

• attemptintegerObligatorio

  The specific attempt number of the quiz submission to update. The attempt must have been completed before scores can be updated.

• quiz_idstringObligatorio

  The unique identifier for the quiz to which the submission belongs.

• course_idstringObligatorio

  The unique identifier for the course to which the quiz submission belongs.

• questionsobject

  Scores and comments for individual questions. Keys are question identifiers; values are objects detailing 'score' (float) and 'comment' (string) for feedback, enabling detailed per-question grading.

• fudge_pointsnumber

  A numerical value (positive or negative) used to manually adjust the total score of the quiz submission. This can be used for applying discretionary bonuses or penalties.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The unique identifier of the user whose settings are to be updated.

• collapse_course_navboolean

  If `true`, course navigation menus will load collapsed by default.

• collapse_global_navboolean

  If `true`, the global navigation menu will load collapsed by default.

• manual_mark_as_readboolean

  If `true`, user must manually mark discussion posts as read; `false` means posts are marked read automatically upon viewing.

• hide_dashcard_color_overlaysboolean

  If `true`, color overlays on dashboard course card images will be hidden.

• release_notes_badge_disabledboolean

  If `true`, the badge indicating new release notes will be hidden.

• elementary_dashboard_disabledboolean

  If `true`, the classic Canvas dashboard view is displayed; `false` displays the Canvas for Elementary view.

• comment_library_suggestions_enabledboolean

  If `true`, suggestions from the comment library will be displayed when commenting.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• fileobjectObligatorio

  File containing its name and readable content buffer.

• course_idstringObligatorio

  Unique identifier of the accessible Canvas course.

• on_duplicatestring

  Action for duplicate filenames: 'overwrite' or 'rename'. If unspecified, Canvas's default behavior applies.

• parent_folder_idinteger

  Unique ID of the target folder. If omitted, uploads to the course's root folder. Mutually exclusive with `parent_folder_path`.

• parent_folder_pathstring

  Full path to the target folder (e.g., 'course_materials/week1'). If omitted, uploads to the course's root folder. Mutually exclusive with `parent_folder_id`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• fileobjectObligatorio

  The file to upload as the submission.

• user_idstringObligatorio

  Identifier of the user (e.g., student) making the submission; use 'self' for the currently authenticated user.

• course_idstringObligatorio

  Identifier of the course containing the assignment.

• assignment_idstringObligatorio

  Identifier of the assignment for the submission.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not