API Change Log Archive
The Change Log Archive page displays previous API changes in the API Change Log older than the last four releases.
The release date indicates the date that the API code was made available in the production environment.
## 2019-06-01
### Additions
| Resources | Function | |
|----------------------|----------------------|--------------------------|
| [Files API] | Get Uploaded Media Folder for User Endpoint | Added endpoint |
| [Originality Report API] | Create an Originality Report
Edit an Originality Report | Added originality_report[error_message] parameter
| | Originality Report Object | Returns Error_report |
Removals
| Resources |
Function |
|
| File Uploads |
Uploading via POST Process |
Step 3: Deprecated POST requests in favor of GET requests for forward compatibility |
2019-05-11
Additions
| Resources |
Function |
|
| Assignments API |
Create an Assignment Endpoint
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
| Resources |
Function |
|
| 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
| Resources |
Function |
|
| Content Migrations API |
Create a Content Migration Endpoint |
Added selective_import parameter |
|
List Items for Selective Import Endpoint |
Added endpoint |
Changes
| Resources |
Function |
|
| 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
| Resources |
Function |
|
| SIS Imports API |
Imports SIS Data Endpoint |
Added change_threshold parameter |
Removals
| Resources |
Function |
|
| 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
| Resources |
Function |
|
| Users API |
Edit a User Endpoint |
Added [user]title and [user]bio parameters |
2019-01-26
Additions
| Resources |
Function |
|
| 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 |
| Users API |
|
Added AnonyousUserDisplay Object |
Changes
| Resources |
Function |
|
| Submissions API |
List Gradeable Students Endpoint |
Added clarification about anonymous grading |
Removals
| Resources |
Function |
|
| 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
| Resources |
Function |
|
| Assignments API |
Create an Assignment Endpoint
Edit an Assignment Endpoint |
Added assignment[allowed_attempts] parameter |
|
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
SIS Import Statistic Objects |
Added object examples |
|
SIS Import Object |
Workflow_state parameter: Added initializing and failed descriptions
Added statistics parameter |
| Submissions API |
Submission Object |
Added extra_attempts parameter |
Changes
| OAuth2 |
File |
|
| Developer Keys |
|
Verified and corrected all links in document |
| Resources | Function | |
|----------------------|----------------------|--------------------------|
| [Files API] | Delete File Endpoint | Clarified endpoint usage and added permanent deletion warning |
Removals
| External Tools |
Function |
|
| Navigation Tools |
|
Removed incorrect auto-generated links from page |
| Resources | Function | |
|---------------|-----------|---|
| [Courses API] | List Users in Course Endpoint | Include parameter: Removed email as an optional parameter |
2018-12-08
Additions
| Resources |
Function |
|
| Courses API |
List Your Courses Endpoint |
Include parameter: Added graded period parameters to be returned even if total grades are hidden in the course |
| SIS Import Errors API |
SISImportError Object |
Added row_info parameter, which displays the contents of the line that had the error |
| Users API |
List the Activity Stream Endpoint |
Added only_active_courses parameter |
Changes
| Resources |
Function |
|
| SIS Imports API |
Abort SIS Import Endpoint
Get SIS Import List Endpoint |
Added clarification that aborting a sis batch can take time and subsequent sis batches begin to process 10 minutes after the abort.
Workflow_state parameter: added initializing, failed, restoring, partially_restored, and restored as allowed values |
2018-11-17
Additions
| External Tools |
Function |
|
| Variable Substitutions |
com.instructure.Person.name_sortable |
Added variable that returns the sortable name of the launching user. Availability is when launched by a logged in user |
| Resources | Function | |
|-------------------|-----------------------------------------------|---|
| [SIS Imports API] | Get the Current Importing SIS Import Endpoint | Added endpoint to return the SIS imports that are currently processing for an account |
Changes
| Resources |
Function |
|
| Assignments API |
List Assignments Endpoint |
Clarified that the paginated list of assignments is returned for the current course or assignment group |
| Rubrics API |
Create a Single Rubric Endpoint |
Clarified the rubric return value |
| Roles API |
Create a New Role Endpoint |
Permissions parameter: Updated account- and course-level role names to match roles in the Canvas Permissions page |
Removals
| Resources |
Function |
|
| Planner API |
|
Removed the beta warning banner from the API documentation |
2018-10-27
Additions
Changes
| Resources |
Function |
|
| Conversations API |
Create a Conversation Endpoint |
Recipients parameter: Added clarification when the course/group has over 100 enrollments, bulk_message and group_conversation must be set to true |
| Quiz Extensions API |
Set Extensions for Student Quiz Submissions Endpoint |
All parameters: Added quiz_extensions to parameter name |
| Quiz Submissions API |
Update Student Question Scores and Comment Endpoint |
All parameters: Added quiz_submissions to parameter name |
2018-10-06
Additions
Changes
| Basics |
File |
|
| File Uploads |
Uploading via POST |
Step 3: Clarified file management system transition and newer file upload process |
| OAuth2 |
Function |
|
| OAuth2 Endpoints |
Get login/oauth2/auth |
Below parameters table, clarified info on scopes for OAuth2 endpoint |
| Resources |
Function |
|
| Accounts API |
Permissions Endpoint |
Added links to Course and Group permissions |
| Courses API |
Permissions Endpoint |
Added links to Account and Group permissions |
Removals
| Basics |
File |
|
| File Uploads |
Uploading via POST |
Step 3: Deprecated POST requests in favor of GET requests for forward compatibility, to be removed 2019-04-21 |
2018-09-15
Additions
| External Tools |
File |
|
| Variable Substitutions |
com.instructure.Assignment.anonymous_grading
com.Instructure.membership.roles |
Returns true if the assignment has anonymous grading enabled
Returns true if the assignment has anonymous grading enabled |
| Resources | Function | |
|-------------------|---------------------------------|---|
| [Accounts API] | Get Help Links Endpoint | Returns the help links for that account |
| [Blueprint Courses API] | BlueprintSubscription Object
List Blueprint Subscriptions Endpoint | Returns the ID of the blueprint course and blueprint template the associated course is subscribed to
Returns a list of blueprint subscriptions for the given course (currently a course may have no more than one) |
| [Custom Gradebook Columns API] | Bulk Update Column Data | Sets the content of custom columns |
| [SIS Imports API] | SIS Import Object | CSV\_attachments parameter: Returns an array of CSV files for processing |
2018-08-04
Additions
| Resources |
Function |
|
| Outcome Results API |
Get Outcome Result Rollups |
Exclude parameter: Specified additional values to exclude. “Missing_user_rollups” excludes rollups for users without results.
Aggregate_stat parameter: If aggregate rollups requested, then this value determines what statistic is used for the aggregate. Defaults to “mean” if this value is not specified. |
Changes
| Outcomes |
File |
|
| Outcomes Data Format |
outcomes.csv |
Vendor_guid field: Clarified that vendor_guid IDs will prefix “canvas_outcome:” and “canvas_outcome_group:” for outcomes and groups, respectively. In addition, these prefixes are reserved; newly created outcomes and groups may not have vendor_guid fields with these prefixes. |
| Resources | Function | |
|-------------------|---------------------------------|---|
| [Outcome Results API] | Get Outcome Result Rollups | Aggregate parameter: Clarified that the median is a separate parameter |
2018-07-14
Additions
Changes
| Resources |
Function |
|
| Plagiarism Detection Platform APIs |
|
In the API page sidebar, moved all API documentation for the plagiarism platform to the External Tools section |
2018-06-23
Additions
| Resources |
Function |
|
| SIS Imports API |
Restore workflow_states of SIS Imported Items Endpoint |
Added endpoint |
Changes
| Resources |
Function |
|
| Files API |
File Object |
Updated file object example and ordering; object returns uuid, folder_id, display_name, and modified_at fields |
| Users API |
Get a Pandata JWT Token and its Expiration Date |
Changed endpoint to reflect use for current user only (/api/v1/users/self/pandata_token)
Clarified description in that endpoint is currently only available to the mobile developer keys |
2018-06-02
Additions
| External Tools |
File |
|
| Grading |
|
Added Submission Details Return Extension documentation, which includes information about supporting Submitted At timestamps |
| Resources | Function | |
|-------------------|---------------------------------|---|
| [Content Exports API] | Export Content Endpoint | Added select parameter |
| [External Tools API] | Create an External Tool Endpoint | Added account\_navigation\[display\_type\] parameter |
| [Submissions API] | Submission Summary Endpoint | Added grouped parameter |
| [Users API] | Create a User | Added destination parameter
2018-05-12
Additions
| Resources |
Function |
|
| Accounts API |
List Active Courses in an Account |
Include parameter: Added account_name value |
| Communication Channels API |
Delete a Push Notification Endpoint |
Added endpoint |
| Courses API |
List Your Courses Endpoint
List Courses for a User Endpoint
Get a Single Course Endpoint |
include parameter: Added account object |
| Enrollments API |
List Enrollments Endpoint |
Added enrollment_term_id parameter |
| Submissions API |
List Submissions for Multiple Assignments Endpoint |
Added graded_since parameter |
| Users API |
Create a User Endpoint |
Added destination parameter |
| User Observees API |
Add an Observee with Credentials Endpoint
Add an Observee Endpoint
Remove an Observee Endpoint |
Added root_account_id parameter |
Changes
| Resources |
Function |
|
| Accounts API |
List Active Courses in an Account Endpoint |
Sort parameter: replaced subaccount value with account_name value. Subaccount can still be used as a value for backward compatibility. |
| User Observees API |
List Observees Endpoint |
Clarifies that the returned observees will include the observation_link_root_account_ids attribute |
2018-04-21
Additions
| Resources |
Function |
|
| Accounts API |
|
Added permissions Endpoint |
| Discussion Topics API |
Get a Single Topic Endpoint
List Discussion Topics Endpoint |
Added include parameter; include overrides as an allowed value |
| Modules API |
Module Object
ModuleItem SequenceNode Object
ModuleItemSequence Object |
Returns the published parameter
Returns the mastery_path parameter and includes examples for the current and next items in the course
Returns full examples for items and modules arrays |
| Sections API |
Create Course Section Endpoint |
Course_section[integration_id] parameter: sets the integration_id of the section |
| SIS Imports API |
Import SIS Data Endpoint |
Skip_deletes parameter: can be used on any type of SIS import; when set, the import will skip any deletes |
|
SISImport Object |
Workflow_state parameter: returns whether the SIS import was aborted
Skip_deletes parameter: returns whether the import skipped any deleted objects |
| SIS Import Errors API |
Get SIS Import Error List Endpoint |
Returns a list of SIS import errors for an account or SIS import |
| Users API |
Get a Pandata JWT Token and its Expiration Date Endpoint |
Returns a jwt token, which can be used to send events to Canvas Data |
| SIS | File | |
|-------------------|---------------------------------|---|
| [SIS CSV Format] | changes\_sis\_id.csv | Added group\_category as a type
Old\_integration\_id field: description clarifies that this field does not support group categories
New\_integration\_id field: description clarifies that this field does not support group categories |
Changes
| Resources |
Function |
|
| Courses API |
Permissions Endpoint |
Includes link to Accounts API Permissions Endpoint
Clarifies that permission names are documented in the Create a Role Endpoint |
| Sections API |
Create Course Section Endpoint |
Course_section[sis_section_id] parameter: Notes the user must have the manage_sis permissions to set |