Edit

Share via

educationSynchronizationCustomization resource type (deprecated)

  • Article

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).

Provides settings for customizing the school data profile synchronization of the resource entities. The customization can be applied to all the entities being synchronized.

Properties

Property Type Description
optionalPropertiesToSync String collection The collection of property names to sync. If set to null, all properties will be synchronized. Does not apply to Student Enrollments or Teacher Rosters
synchronizationStartDate DateTime The date that the synchronization should start. This value should be set to a future date. If set to null, the resource will be synchronized when the profile setup completes. Only applies to Student Enrollments
isSyncDeferred Boolean Indicates whether synchronization of the parent entity is deferred to a later date.
allowDisplayNameUpdate Boolean Indicates whether the display name of the resource can be overwritten by the sync.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "optionalPropertiesToSync": ["String"],
  "synchronizationStartDate": "DateTimeOffset",
  "isSyncDeferred": "Boolean",
  "allowDisplayNameUpdate": "Boolean"
}