For Developers

Update Category

PATCH https://ed.link/api/v2/my/classes/:class\_id/categories/:category\_id

Update an existing Category in the given Class.

The user must be enrolled as a teacher, ta, designer, administrator, or district-administrator in the class to use this endpoint.

Please review our guide on patch requests for more information regarding their use.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.
category_idstringThe UUID of the desired Category.

Request Body

The request body should contain a partial Category object.

The following fields are allowed: title, weight, drop_lowest, position.

{
    "title": "Quizzes"
}

Sample Response

The response contains the updated Category object.

{
    "$data": {
        "title": "Quizzes",
        "position": 2,
        "updated_date": "2021-12-27T18:53:45.077Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    "$request": "00000000-0000-0000-0000-000000000000"
}