For Developers
Create Page
POST https://ed.link/api/v2/my/classes/:class_id/pages
Create a new Page 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
Parameter | Type | Description |
---|---|---|
class_id | string | The UUID of the desired Class. |
Request Body
The request body should contain an Page object.
The following fields are allowed: title
, description
, description_plaintext
, state
, attachments
, display_date
, assignee_mode
, assignee_ids
, section_ids
, and module_id
.
The following fields are required: title
and description
.
{
"title": "Sample Page",
"description": "This is the description of the page"
}
Sample Response
The response contains the newly created Page object.
{
"$data": {
"title": "Sample Page",
"description": "This is the description of the page",
"attachments": [],
"created_date": "2021-12-23T22:24:39.934Z",
"updated_date": "2022-01-03T20:49:09.233Z",
"id": "00000000-0000-0000-0000-000000000000"
},
"$request": "00000000-0000-0000-0000-000000000000"
}
Additional Notes
module_id
is a POST
only field. In order to view modules that include this page, you must use the Resource endpoint.