Pause sync on an educationSynchronizationProfile

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

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

Permissions

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 Not supported.

HTTP request

POST /synchronizationProfiles/{id}/pause

Request headers

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

Request body

Do not supply a request body for this method.

Response

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

Example

Request

The following is an example of the request.

POST https://graph.microsoft.com/beta/education/synchronizationProfiles/{id}/pause
Response

There is no response body.

HTTP/1.1 200 OK