For Developers

Update Module

PATCH https://ed.link/api/v2/my/classes/:class_id/modules/:module_id

Update a Module in a Class.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.
module_idstringThe UUID of the desired Module.

The following fields are allowed: title, display_date, .

The following fields are required: .

Request Body

As usual with PATCH requests, send a partial Module object.

{
    "title": "My Module created by API (updated)"
}

Sample Request

axios.post(
    `https://ed.link/api/v2/my/classes/${class_id}/modules/${module_id}`,
    {
        title: 'My Module created by API (updated)'
    },
    {
        headers: {
            authorization: `Bearer ${person_access_token}`
        }
    }
);

Response Data

On success, this endpoint returns a normal Module object.

{
    "$request": "00000000-0000-0000-0000-000000000000",
    "$data": {
        "title": "My Module created by API (updated)",
        "display_date": "2025-09-19T15:00:00.000Z",
        "properties": {},
        "identifiers": [
            {
                "type": "canvas_id",
                "value": "123"
            }
        ],
        "rule_ids": [],
        "references": {},
        "id": "00000000-0000-0000-0000-000000000000"
    }
}

Supported Providers

  • canvas