Use this call to change or reset the current period in Anaplan.

This enables an integration to advance or change the model calendar as part of a scheduled planning, forecasting, or period-close process.

When this call contains a specified date (for example, 2020-05-20), the API determines what period range contains the specified data and sets that range as the current period.  When the date value is set to blank in this call, the API resets the current period to blank.

Warning: A change to your time settings is a potentially destructive action and may lead to data loss.  The new range of time periods may not include previous time periods. Any data in the removed time periods is deleted from the model.

Note: To use this call, you must be a Workspace Administrator

Method and endpoint

PUT

/workspaces/{workspaceId}/models/{modelId}/currentPeriod

Curl example

curl -X PUT https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/currentPeriod\
-H 'Accept: application/json' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json'

Response

Response header

Content-Type: application/json

Response 200 body

{
   "meta":{
      "schema":"https://api.anaplan.com/2/0/objects/currentPeriod"
   },
   "status":{
      "code":200,
      "message":"Success"
   },
   "currentPeriod":{
      "periodText":"May 20",
      "lastDay":"2020-05-31",
      "calendarType":"Calendar Months/Quarters/Years"
   }
}