Pause sync on an educationSynchronizationProfile

Namespace: microsoft.graph


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.

Pause the sync of a specific school data synchronization profile in the tenant.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions
Delegated (work or school account) EduAdministration.ReadWrite
Delegated (personal Microsoft account Not supported.
Application EduAdministration.ReadWrite.All

HTTP request

POST /education/synchronizationProfiles/{id}/pause

Request headers

Name Type Description
Authorization string Bearer {token}. Required.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code.



The following is an example of the request.


There is no response body.

HTTP/1.1 200 OK