For Developers

Create Category

POST https://ed.link/api/v2/my/classes/:class_id/categories

Create a new 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.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.

Request Body

The request body should contain an Category object.

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

The following fields are required: title, .

Different providers may require different fields, and in most cases we try to default to something reasonable, but it is recommended to pass all the fields explicitly.

{
    "title": "Example Category",
    "position": 2
}

Sample Response

The response contains the newly created Category object.

{
    "$data": {
        "title": "Example Category",
        "position": 2,
        "updated_date": "2021-12-27T18:53:45.077Z",
        "properties": {},
        "identifiers": [
            {"type":"schoology_id", "value": 123}
        ],
        "id": "00000000-0000-0000-0000-000000000000"
    },
    "$request": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

  • aspen
  • blackbaud
  • brightspace
  • canvas
  • classgather
  • google
  • microsoft
  • oneroster
  • powerschool
  • schoology
  • skyward
  • qmlativ
  • infinitecampus
  • rapididentity
  • sapphire
  • genesis
  • renweb