2019 API Change Log Archive
The Change Log Archive page displays previous API changes from 2019 formerly noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.
2019-12-04
Additions
Media Objects API | MediaObject Object
- Returns user_entered_title, title, media_id, and media_type parameters
External Tools LTI Variable Substitutions
- Added com.instructure.Person.pronouns variable
External Tools Editor Button Placement | Settings
- Added documentation for Visibility placement
2019-11-20
Additions
Originality Reports API | Create an Originality Report Endpoint
- Added originality_report[attempt] parameter
Changes
External Tools API Documentation Section
- Revised all External Tools API documentation to include LTI Advantage and improve sidebar navigation.
2019-11-06
Additions
Assignments API | List Assignments Endpoint
- Order_by parameter: added due_at value
Content Migrations API | Create a Content Migration Endpoint
- Added settings[move_to_assignment_group_id] parameter
2019-10-23
Additions
- Added EnrollmentTermsList Object
Changes
Enrollment Terms API | List Enrollment Terms
- Added description
2019-10-09
Changes
Courses API | Create a New Course Endpoint | Course[grade_passback_setting] parameter
- Added Disabled as an optional grade passback value
- Added inherent functionality for instructor enrollments to read term information for their root account through the Terms API. This change assists tools that uses the API to determine if a course is open or closed and no longer requires admin enrollments only.
Planner API | List Planner Items Endpoint
- Added clarification that planner items for a student may also be retrieved by a linked observer. Use the path that accepts a user_id and supply the student’s ID.
Rubrics API | Create a Rubric Endpoint
- Added descriptions to multiple parameters
Rubrics API | Update a Rubric Endpoint
- Added descriptions to multiple parameters
2019-09-25
Additions
Content Migrations API | Create a Content Migration
- Added select parameter, which allows users to select objects to copy
Plagiarism Detection Platform Users API | Get a single user (LTI) endpoint
- Added user email to json response
Plagiarism Detection Platform Users API | Get all users in a group (LTI) endpoint
- Added user email to json response
2019-09-21
Changes
Submissions API | Upload a File Endpoint
- Added validation for file type; if a submission is set to accept only specific file types, the endpoint rejects uploaded file types not included for submission uploads
2019-07-31
Additions
Assignments API | List Assignment Endpoint
- Added post_to_sis parameter
- Added link to LTI Advantage documentation and section for accessing LTI Advantage Services
SIS CSV Format | Logins.csv
- Added file
Changes
SIS CSV Format | Courses.csv
- Clarified description for account_id to specify that new courses will be attached to the root account if not specified
2019-07-13
Additions
Assignments API | Assignment Object
- Added posted_manually parameter
- Added file
Submissions API | Submissions Object
- Added posted_at parameter
Variable Substitutions | Canvas.course.sectionRestricted
- Added variable that corresponds with whether the user was enrolled with the restriction to only interact with users in their own section
Changes
Assignments API | Assignment Object | Muted Parameter
- Updated description for muted parameter regarding Old and New Gradebooks
Conversations API | Create a Conversation Endpoint | Group_conversation parameter
- Updated description to indicate the value must be set to true if the number of recipients is over the set maximum (100)
Deprecations
Assignments API | Create an Assignment Endpoint | Assignment[muted] parameter
- Deprecated for New Gradebook, to be removed 2020-01-18
- This parameter may only still be used with the Old Gradebook
2019-06-22
Additions
Users API | List Users in Account Endpoint
- Added enrollment_type parameter
2019-06-01
Additions
Files API | Get Uploaded Media Folder for User Endpoint
- Added endpoint
Originality Report API | Create an Originality Report
- Added originality_report[error_message] parameter
Originality Report API | Edit an Originality Report
- Added originality_report[error_message] parameter
Originality Report API | Originality Report Object
- Returns Error_report
Removals
File Uploads | Uploading via POST Process
- Step 3: Deprecated POST requests in favor of GET requests for forward compatibility
- Previous announcement date: 2018-10-06
2019-05-11
Additions
Assignments API | Create an Assignment Endpoint
- Added assignment [grader_count], assignment [final_grader_id], assignment [grader_comments_visible_to_graders], assignment [graders_anonymous_to_graders], assignment [graders_names_visible_to_final_grader], assignment [anonymous_grading] parameters
Assignments API | Edit an Assignment Endpoint
- Added assignment [grader_count], assignment [final_grader_id], assignment [grader_comments_visible_to_graders], assignment [graders_anonymous_to_graders], assignment [graders_names_visible_to_final_grader], assignment [anonymous_grading] parameters
SIS Imports API | Import SIS Data Endpoint
- Added diff_row_count_threshold parameter
Users API | Merge User Into Another User Endpoint
- Added user merge details and caveats for behaviors relating to avatars, terms of use, communication channels, enrollments, submissions, access tokens, conversations, favorites, and LTI tools
2019-04-20
Additions
Submissions API | Grade or Comment on a Submission Endpoint
- Rubric_assessment parameter: Added rubric_assessment[criterion_id][rating_id] sub-parameter
- Added rating IDs to example rubric in description
Users API | Update User Settings Endpoint
- Added hide_dashcard_color_overlays parameter
2019-03-30
Additions
Content Migrations API | Create a Content Migration Endpoint
- Added selective_import parameter
Content Migrations API | List Items for Selective Import Endpoint
- Added endpoint
Changes
Content Migrations API | Update a Content Migration Endpoint
- Clarified the endpoint takes same arguments as creating a migration
- Clarified that updating the content migration will also be used when importing content selectively
2019-03-09
Changes
SIS Imports API | Imports SIS Data Endpoint
Added change_threshold parameter
Users API | To Do Items Endpoint
- Removed mention of user dashboard, as this API call is not used for the dashboard
2019-02-16
Additions
Users API | Edit a User Endpoint
- Added [user]title and [user]bio parameters
2019-01-26
Additions
Assignments API | Assignment Object
- Returns grader_count, final_grader, grader_comments_visible_to_graders, graders_anonymous_to_graders, grader_names_visible_to_final_grader, and anonymous_grading parameters
Submissions API | Submission Object
- Returns UserDisplay parameter
- Added AnonyousUserDisplay Object
Changes
Submissions API | List Gradeable Students Endpoint
- Added clarification about anonymous grading
Removals
Enrollments API | Enrollment Object
- Removed computed_current_score, computed_final_score, computed_current_grade, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters
2019-01-05
Additions
Assignments API | Create an Assignment Endpoint
- Added assignment[allowed_attempts] parameter
Assignments API | Edit an Assignment Endpoint
- Added assignment[allowed_attempts] parameter
Assignments API | Assignment Object
- Added allowed_attempts parameter
Conversations API | Create a Conversations Endpoint
- Added force_new parameter
Courses API | Get a Single Course Endpoint
- Added teacher_limit parameter
Enrollments API | Enrollment Object
- Added override_grade, override_score, current_period_override_grade, and current_period_override_score parameters
- Added override score clarifications in computed_current_score, computed_final_score, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters
Roles API | Create a New Role Endpoint
- Permissions_enabled parameter: Added view_audit_trail in permissions list
SIS Imports API | SIS Import Statistic Object
- Added object examples
SIS Imports API | SIS Import Statistic Objects
- Added object examples
SIS Imports API | SIS Import Object
- Workflow_state parameter: Added initializing and failed descriptions
- Added statistics parameter
Submissions API | Submission Object
- Added extra_attempts parameter
Changes
- Verified and corrected all links in document
Files API | Delete File Endpoint
- Clarified endpoint usage and added permanent deletion warning
- Removed incorrect auto-generated links from page
Removals
Courses API | List Users in Course Endpoint
- Include parameter: Removed email as an optional parameter
View 2018 Canvas API Change Log Archive
