For Developers
Create Module
POST https://ed.link/api/v2/my/classes/:class_id/modules
Create a new Module in a Class.
Request Parameters
Parameter | Type | Description |
---|---|---|
class_id | string | The UUID of the desired Class. |
The following fields are allowed: title
, display_date
.
The following fields are required: title
.
Request Body
{
"title": "My Module created by API",
"display_date": "2025-09-19T15:00:00.000Z"
}
Sample Request
axios.post(
`https://ed.link/api/v2/my/classes/${class_id}/modules`,
{
title: 'My Module created by API',
display_date: '2025-09-19T15:00:00.000Z'
},
{
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",
"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