Update historyItem

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.

Update the properties of a historyItem object.

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 permission	Higher privileged permissions
Delegated (work or school account)	Not supported.	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

PATCH /me/planner/plans_v2/{planId}/historyItems/{historyItemId}
PATCH /users/{usersId}/planner/plans_v2/{planId}/historyItems/{historyItemId}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
planId	String	ID of the plan the change occurred in. Optional.
entityId	String	ID of the entity the history item describes. Optional.
entityType	historyEntityType	Type of the entity the history item describes. The possible values are: task, unknownFutureValue. Optional.
eventType	historyEventType	Type of the change event that occurred. The possible values are: created, updated, deleted, undeleted, moved, unknownFutureValue. Optional.
occurredDateTime	DateTimeOffset	Date and time the change occurred. Read-only. Optional.
actor	identitySet	Identity of the user (or application) that performed the change. Optional.
oldData	String	Serialized representation of the entity state before the change. Optional.
newData	String	Serialized representation of the entity state after the change. Optional.

Response

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

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/me/planner/plans_v2/{planId}/historyItems/{historyItemId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.historyItem",
  "planId": "b3d9f9a2-3e14-4a4b-9b2b-6b6d9e6a2f31",
  "entityId": "a5f3d9c2-7b41-4e6d-9c2a-1f8b3d6a9e42",
  "entityType": "task",
  "eventType": "updated",
  "occurredDateTime": "2026-06-15T09:30:00Z",
  "actor": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "oldData": "{\"status\":\"notStarted\"}",
  "newData": "{\"status\":\"inProgress\"}"
}

Response

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

{
  "@odata.type": "#microsoft.graph.historyItem",
  "id": "02636413-50f8-710f-bed1-a0f488aa4e54",
  "planId": "String",
  "entityId": "String",
  "entityType": "String",
  "eventType": "String",
  "occurredDateTime": "String (timestamp)",
  "actor": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "oldData": "String",
  "newData": "String"
}