Update educationclass properties
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Update the properties of a class.
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) | 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. Learn more about authentication and authorization. |
Content-Type | application/json |
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains 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 |
---|---|---|
description | String | Description of the class. |
displayName | String | Name of the class. |
mailNickname | String | Email alias for sending email to all users if that feature is enabled. |
classCode | String | Class code used by the school. |
externalId | String | ID of the class from the syncing system. |
externalName | String | Name of the class in the syncing system. |
externalSource | string | How this class was created. Possible values are: sis , manual , enum_sentinel . |
Response
If successful, this method returns a 200 OK
response code and an updated educationClass object in the response body.
Example
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/education/classes/11014
Content-type: application/json
{
"description": "History - World History 1",
"displayName": "World History Level 1",
}
Response
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
{
"id": "11014",
"description": "World History Level 1",
"classCode": "301",
"createdBy": {
"user": {
"displayName": "Susana Rocha",
"id": "14012",
}
},
"displayName": "History - World History 1",
"externalId": "301",
"externalName": "World History Level 1",
"externalSource": "Fabrikam High School",
"mailNickname": "Fabrikam"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for