Update yearTimePeriodDefinition

Namespace: microsoft.graph.industryData


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 yearTimePeriodDefinition object.

This API is supported in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


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

Permission type Permissions (from least to most privileged)
Delegated (work or school account) IndustryData-TimePeriod.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application IndustryData-TimePeriod.ReadWrite.All

HTTP request

PATCH /external/industryData/years/{yearTimePeriodDefinitionId}

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

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

The following table specifies the properties that can be updated.

Property Type Description
displayName String The name of the year. Maximum supported length is 100 characters. Required.
endDate Date The last day of the year using ISO 8601 format for date. Required.
startDate Date The first day of the year using ISO 8601 format for date. Required.


If successful, this method returns a 204 No Content response code.



The following is an example of a request.

PATCH https://graph.microsoft.com/beta/external/industryData/years/ebf18762-ab92-487e-21d1-08daddab28bb
Content-Type: application/json
Content-length: 242

  "displayName": "Fiscal Year 2022",
  "id": "ebf18762-ab92-487e-21d1-08daddab28bb"


The following is an example of the response.

HTTP/1.1 204 No Content