Update educationClass

Namespace: microsoft.graph

Update the properties of an educationClass object.

This API is available in the following national cloud deployments.

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


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) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduRoster.ReadWrite.All Not available.

HTTP request

PATCH /education/classes/{id}

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.

Property Type Description
displayName String Name of the class.
mailNickname String Mail name for sending email to all members, if this is enabled.
description String Description of the class.
createdBy identitySet Entity who created the class
classCode String Class code used by the school to identify the class.
externalId String ID of the class from the syncing system.
externalSource educationExternalSource How this class was created. Possible values are: sis, manual
externalSourceDetail String The name of the external source this resources was generated from.
grade String Grade level of the class.
term educationTerm Term for this class.


If successful, this method returns a 200 OK response code and an updated educationClass object in the response body.



The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/education/classes/{class-id}
Content-type: application/json

  "description": "History - World History 1",
  "displayName": "World History Level 1",

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

  "@odata.type": "#microsoft.graph.educationClass",
  "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
  "displayName": "String",
  "mailNickname": "String",
  "description": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  "classCode": "String",
  "externalName": "String",
  "externalId": "String",
  "externalSource": "String",
  "externalSourceDetail": "String",
  "grade": "String",
  "term": {
    "@odata.type": "microsoft.graph.educationTerm"