🚀 Heads up: Our API Docs Have Moved!
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
Assignment Presets API
Manage assignment presets for courses and accounts. Presets store a reusable set of assignment settings (grading type, visibility flags, tool-specific configuration) that can be applied to one or more assignments.
List assignment presets AssignmentPresetsController#index
GET /api/v1/courses/:course_id/assignment_presets
Scope:
url:GET|/api/v1/courses/:course_id/assignment_presets
GET /api/v1/accounts/:account_id/assignment_presets
Scope:
Returns the list of assignment presets accessible from the current context.
This always includes account-level presets from the context's account chain.
For a course context, it also includes the course's own presets.
url:GET|/api/v1/accounts/:account_id/assignment_presets
Get an assignment preset AssignmentPresetsController#show
GET /api/v1/courses/:course_id/assignment_presets/:id
Scope:
url:GET|/api/v1/courses/:course_id/assignment_presets/:id
GET /api/v1/accounts/:account_id/assignment_presets/:id
Scope:
Returns a single assignment preset.
url:GET|/api/v1/accounts/:account_id/assignment_presets/:id
Create an assignment preset AssignmentPresetsController#create
POST /api/v1/courses/:course_id/assignment_presets
Scope:
url:POST|/api/v1/courses/:course_id/assignment_presets
POST /api/v1/accounts/:account_id/assignment_presets
Scope:
Create a new assignment preset in the given context.
url:POST|/api/v1/accounts/:account_id/assignment_presets
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| name | Required | string | The name of the preset. |
| grading_type | string | How grades display (points, percentage, etc.) Defaults to points. | |
| omit_from_final_grade | boolean | Exclude from final grade calculation. | |
| hide_in_gradebook | boolean | Hide the assignment column in the gradebook. | |
| post_to_sis | boolean | Push grades to the Student Information System. | |
| anonymous_grading | boolean | Anonymize student identity during grading. | |
| settings | Object | Tool-specific settings. |
Update an assignment preset AssignmentPresetsController#update
PUT /api/v1/courses/:course_id/assignment_presets/:id
Scope:
url:PUT|/api/v1/courses/:course_id/assignment_presets/:id
PUT /api/v1/accounts/:account_id/assignment_presets/:id
Scope:
Update an existing assignment preset.
url:PUT|/api/v1/accounts/:account_id/assignment_presets/:id
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| name | string | The name of the preset. | |
| grading_type | string | How grades display. | |
| omit_from_final_grade | boolean | no description | |
| hide_in_gradebook | boolean | no description | |
| post_to_sis | boolean | no description | |
| anonymous_grading | boolean | no description | |
| settings | Object | Tool-specific settings. |
Delete an assignment preset AssignmentPresetsController#destroy
DELETE /api/v1/courses/:course_id/assignment_presets/:id
Scope:
url:DELETE|/api/v1/courses/:course_id/assignment_presets/:id
DELETE /api/v1/accounts/:account_id/assignment_presets/:id
Scope:
Soft-deletes an assignment preset.
url:DELETE|/api/v1/accounts/:account_id/assignment_presets/:id