Reset sync on an educationSynchronizationProfile (deprecated)

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.

Caution

The Education Synchronization Profile API is deprecated and will stop returning data on December 31, 2024. For information about how to migrate to the new Industry Data API, see Transition from School Data Sync (Classic).

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

Note: This operation will cause synchronization to restart. Any errors encountered will be deleted. No data will be deleted from Microsoft Entra ID.

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

HTTP request

POST /education/synchronizationProfiles/{id}/reset

Request headers

Name Type Description
Authorization string Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

Example

Request

The following example shows a request.

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

There is no response body.

HTTP/1.1 200 OK