Update Assignment
PATCH https://ed.link/api/v2/graph/classes/:class_id/assignments/:assignment_id
Update an existing Assignment. This is often useful for changing an Assignment's state
from 'draft'
to 'open'
.
If you are trying to submit grades or student work, see Submissions.
Request Parameters
Parameter | Type | Description |
---|---|---|
class_id | string | The UUID of the desired Class. |
assignment_id | string | The UUID of the desired Assignment. |
Request Body
The request body should contain a partial Assignment object.
The following fields are allowed: title
, description
, description_plaintext
, state
, due_date
, display_date
, start_date
, end_date
, assignee_mode
, assignee_ids
, section_ids
, points_possible
, grading_type
, submission_types
, max_attempts
, session_id
, category_id
, attachments
, properties
.
{
"category_id": "00000000-0000-0000-0000-000000000000",
"assignee_mode": "all",
"grading_type": "points",
"max_attempts": 1,
"state": "open"
}
Sample Request
axios.patch('https://ed.link/api/v2/graph/classes/00000000-0000-0000-0000-000000000000/assignments/00000000-0000-0000-0000-000000000000', {
headers: {
authorization: `Bearer ${integration_access_token}`
},
data: {
category_id: '00000000-0000-0000-0000-000000000000',
assignee_mode: 'all',
grading_type: 'points',
max_attempts: 1,
state: 'open'
}
});
Sample Response
The response contains the updated Assignment object.
{
"$data": {
"attachments": [],
"assignee_mode": "all",
"grading_type": "points",
"max_attempts": 1,
"title": "Week 12 Homework",
"submission_types": ["link"],
"state": "open",
"points_possible": 10,
"created_date": "2021-12-23T22:24:39.934Z",
"updated_date": "2022-01-03T20:49:09.233Z",
"due_date": "2022-01-28T18:00:24.573Z",
"id": "00000000-0000-0000-0000-000000000000",
"category_id": "00000000-0000-0000-0000-000000000000"
},
"$request": "00000000-0000-0000-0000-000000000000"
}
Additional Notes
Canvas requires you to "publish" the Assignment before you can modify student Submissions (i.e. submit or grade them).
Do that by calling this endpoint with the state
property set to 'open'
.
Supported Providers
- aeries
- aspen
- blackbaud
- blackboard
- brightspace
- canvas
- classgather
- clever
- facts
- illuminate
- microsoft
- moodle
- oneroster
- powerschool
- schoology
- lti
- skyward
- veracross
- qmlativ
- infinitecampus
- rapididentity
- sapphire
- genesis
- rediker
- renweb
- synergy
- managebac
- tyler
- banner
- frontline
- ascender