Create educationModule

Namespace: microsoft.graph

Create a new module in a class.

Only teachers in a class can create a module. Modules start in the draft state, which means that students can't see the modules until publication.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) EduCurricula.ReadWrite Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduCurricula.ReadWrite.All Not available.

HTTP request

POST /education/classes/{id}/modules

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of an educationModule object.

Response

If successful, this method returns a 201 OK response code and an educationModule object in the request body.

Example

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/modules
Content-type: application/json

{
    "displayName": "Module 1",
    "description": "Description for Module 1"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#education/classes('37d99af7-cfc5-4e3b-8566-f7d40e4a2070')/modules/$entity",
    "displayName": "Module 1",
    "description": "Description for Module 1",
    "resourcesFolderUrl": null,
    "isPinned": false,
    "status": "draft",
    "createdDateTime": "2024-01-17T17:41:42.8815952Z",
    "lastModifiedDateTime": "2024-01-17T17:41:43.2233686Z",
    "id": "1b9a03b6-dcc5-4ff1-8226-b92e25072f43",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "id": "fadaae59-b18c-44d1-993f-fe8a281bd69c",
            "displayName": null
        }
    },
    "lastModifiedBy": {
        "application": null,
        "device": null,
        "user": {
            "id": "fadaae59-b18c-44d1-993f-fe8a281bd69c",
            "displayName": null
        }
    }
}