Update educationSchool

Namespace: microsoft.graph

Update the properties of an educationSchool 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/schools/{id}

Request headers

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

Request body

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

The following table shows the properties that are required when you update the educationSchool.

Property Type Description
displayName String Display name of the school. Inherited from educationOrganization.
description String Description of the school. Inherited from educationOrganization.
externalSource educationExternalSource Source where this organization was created from. Inherited from educationOrganization. Possible values are: sis, manual.
externalSourceDetail String The name of the external source this resources was generated from.
principalEmail String Email address of the principal.
principalName String Name of the principal.
externalPrincipalId String ID of principal in syncing system.
highestGrade String Highest grade taught.
lowestGrade String Lowest grade taught.
schoolNumber String School Number.
externalId String ID of school in syncing system.
phone String Phone number of school.
fax String Fax number of school.
createdBy identitySet Entity who created the school.
address physicalAddress Address of the school.


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



The following example shows a request.

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

  "displayName": "Fabrikam Arts High School",
  "description": "Magnate school for the arts. Los Angeles School District"


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": "10002",
  "displayName": "Fabrikam Arts High School",
  "description": "Magnate school for the arts. Los Angeles School District",
  "status": "String",
  "externalSource": "String",
  "principalEmail": "AmyR@fabrikam.com",
  "principalName": "Amy Roebuck",
  "externalPrincipalId": "14007",
  "highestGrade": "12",
  "lowestGrade": "9",
  "schoolNumber": "10002",
  "address": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  "externalId": "10002",
  "phone": "+1 (253) 555-0102"