2021 API Change Log Archive
The Change Log Archive page displays previous API changes from 2021 noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.
[2021-08-17 Update]
Please note upcoming changes to Canvas APIs: From the Engineering Deck: Instructure & GraphQL
2021-12-01
Additions
- Added API
2021-11-10
Additions
OutcomeImport Object
- Added learning_outcome_group_id parameter
SIS Import Format Documentation
Users.csv
- In status field, added suspended status, which leaves a student’s enrollment intact but prevents them from logging in
List Missing Submissions Endpoint
- Added observed_user_id parameter
Terminate All User Sessions Endpoint
- Added endpoint
2021-10-27
Additions
- Added API Gateway information and examples
Configuring LTI Advantage Tools
Configuring the Tool in Canvas
- Clarified the Enabled parameter is optional and defaults to true
List Planner Items Endpoint
- Added observed_user_id parameter
SIS Import Format Documentation
Users.csv
- Added declared_user_type field name
2021-09-15
Changes
SIS Import Format Documentation
Courses.csv
- In start_date and end_date fields, added “to remove the date, pass “<delete>”
2021-09-01
Additions
Get Bulk User Progress Endpoint
- Added endpoint
2021-08-18
Additions
Create an External Tool Endpoint
- In User_Navigation[visibility] parameter, added clarification that setting this parameter to null will remove this configuration and use the default behavior, which is public
List User Logins Endpoint
-
Added workflow_state parameter
Edit a User Login Endpoint
-
Added workflow_state parameter
Edit a User Endpoint
-
Added user[event] parameter with suspend, unsuspend values
Changes
Webhooks Subscriptions
- Formerly located in the Resources section, the Webhooks Subscription link has been renamed as Webhooks Subscriptions for Plagiarism Platform and has been moved to the Plagiarism Detection Platform section. This change indicates that Webhooks Subscriptions are only intended for use with the Canvas Plagiarism Detection Platform.
2021-07-21
Additions
Import SIS Data Endpoint
- Added update_sis_id_if_login_claimed parameter
Changes
SIS Import Format Documentation
Logins.CSV
- In the password description, clarified that passwords can only be set one time.
Users.CSV
- In the password description, clarified that passwords can only be set one time.
2021-07-07
Additions
Create a New Role Endpoint
- In permissions[<X>][enabled] parameter, added granular permissions
SIS Import Format Documentation
Enrollments.csv
- In role field, added clarification that custom roles are case sensitive
2021-06-23
Additions
List Courses for a User Endpoint
- Added homeroom parameter
List Active Courses in an Account Endpoint
- Added homeroom parameter
Get SIS Import List Endpoint
- Added created_before parameter
2021-06-19
Additions
Grading Periods Object
- Added grading_period parameter
List your courses, List Courses for a User Endpoints
- Added grading_periods as a value in include[] parameter
- Added Get Visible Course Navigation Tools Endpoint
List Missing Submissions Endpoint
- Added course_ids[] parameter
Profile Object
- Added k5_user parameter
Update User Settings Endpoint
- Added release_notes_badge_disabled parameter
Changes
Update File Endpoint
- Clarified the name parameter has a limit of 255 characters
Removals
Create a New Role Endpoint
- Deprecated manage_courses and change_course_state permission names in permissions[<X>][enabled] parameter
- manage_courses replaced by manage_courses_admin, manage_courses_add
- change_course_state replaced by manage_courses_publish, manage_courses_conclude, manage_courses_delete
- Removal Date: 2021-09-15
2021-06-09
Additions
Import SIS data endpoint
- Added batch_mode_enrollment_drop_status parameter
Related Idea Conversation: Add batch_drop_status param to SIS Import API for batchmode like diffing_drop_status in diffingmode
Removals
- Removed *com_instructure_course_accept_canvas_resource_types launch parameter
- Removed *com_instructure_course_canvas_resource_type launch parameter
- Removed *com_instructure_course_allow_canvas_resource_selection launch parameter
- Removed *com_instructure_course_available_canvas_resources launch parameter
2021-05-15
Additions
Assignment Object
- Added student_annotation as a value to submission_types parameter
Create an Assignment Endpoint
- Added student_annotation as a value to assignment[submission_types] parameter
- Added assignment[annotatable_attachment_id] parameter
Edit an Assignment Endpoint
- Added student_annotation as a value to assignment[submission_types] parameter
- Added assignment[annotatable_attachment_id] parameter
Course Object
- Added Template parameter
Update a Course Endpoint
- Added course[template] parameter
Submission Object
- Added student_annotation as a value to submission_types parameter
2021-05-12
Additions
Assignments API | Assignment Object
- In can_submit parameter, added Not available when observed_users are included
External Tools LTI window.PostMessage
- Added toggleCourseNavigationMenu
Removals
Assignments API | Edit an Assignment Endpoint
- Deprecated ability to change submission type after submissions have been made
- Initial posting date: 2021-03-03
2021-03-31
Changes
Courses API | Create a Course Endpoint, Update a Course Endpoint
- Clarified use of course[restrict_enrollments_to_course_dates] parameter
2021-03-03
Additions
- Added Get a Formatted Student Numerical Answer Endpoint
Roles API | Create a New Role Endpoint
- Added new role permissions in the permissions[<X>][enabled] parameter.
- The manage_admin_users permission will soon be deprecated by eleven new permissions that provide finer granularity in controlling the administration of courses and course enrollments. manage_admin_users OR the eleven new permissions will be available in the API, not both:
- allow_course_admin_actions
- add_designer_to_course
- add_observer_to_course
- add_student_to_course
- add_ta_to_course
- add_teacher_to_course
- remove_designer_from_course
- remove_observer_from_course
- remove_student_from_course
- remove_ta_from_course
- remove_teacher_from_course
Changes
Quiz Questions API | Answer Object
- In answer_weight parameter, changed correct answers should be non-negative to correct answers should be 100
Quiz Statistics API | QuizStatisticsAnswerStatistics Object
- In weight parameter, changed correct answers should be non-negative to correct answers should be 100
Removals
Assignments API | Edit an Assignment Endpoint
- Deprecated ability to change submission type after submissions have been made
- Removal date: 2021-05-12
2021-02-03
Additions
- Added Get User Progress endpoint
View 2020 Canvas API Change Log Archive
Subscribe to this document for content updates. To learn how, see Canvas Change Log FAQ
