Create or replace schedule

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.

Create or replace a schedule object.

The schedule creation process conforms to the One API guideline for resource based long running operations (RELO). When clients use the PUT method, if the schedule is provisioned, the operation replaces the schedule; otherwise, the operation starts the schedule provisioning process in the background.

During schedule provisioning, clients can use the GET method to get the schedule and look at the provisionStatus property for the current state of the provisioning. If the provisioning failed, clients can get additional information from the provisionStatusCode property.

Clients can also inspect the configuration of the schedule.

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

HTTP request

PUT /teams/{teamId}/schedule

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
MS-APP-ACTS-AS A user ID (GUID). Required only if the authorization token is an application token; otherwise, optional.

Request body

In the request body, supply a JSON representation of a schedule object.

Response

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

Examples

Example 1: Update a schedule

Request

The following example shows a request.

PUT https://graph.microsoft.com/beta/teams/{teamId}/schedule
Content-type: application/json

{
  "enabled": true,
  "timeZone": "America/Chicago"
}

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

{
  "id": "833fc4df-c88b-4398-992f-d8afcfe41df2",
  "enabled": true,
  "timeZone": "America/Chicago",
  "provisionStatus": "Completed",
  "provisionStatusCode": null,
  "timeClockEnabled": true,
  "openShiftsEnabled": true,
  "swapShiftsRequestsEnabled": true,
  "offerShiftRequestsEnabled": true,
  "timeOffRequestsEnabled": true,
  "startDayOfWeek": "Sunday",
  "activitiesIncludedWhenCopyingShiftsEnabled": true,
  "isCrossLocationShiftsEnabled": true,
  "isCrossLocationShiftRequestApprovalRequired": true
}

Example 2: Enable location detection for time clock

Request

The following example shows a request.

PUT https://graph.microsoft.com/beta/teams/871dbd5c-3a6a-4392-bfe1-042452793a50/schedule

{
  "enabled": true,
  "timeZone": "America/Chicago",
  "provisionStatus": "Completed",
  "provisionStatusCode": null,
  "openShiftsEnabled": true,
  "swapShiftsRequestsEnabled": true,
  "offerShiftRequestsEnabled": true,
  "timeOffRequestsEnabled": true,
  "startDayOfWeek": "Tuesday",
  "activitiesIncludedWhenCopyingShiftsEnabled": true,
  "isCrossLocationShiftsEnabled": true,
  "isCrossLocationShiftRequestApprovalRequired": true,
  "timeClockEnabled": true,
  "timeClockSettings": {
    "approvedLocation": {
      "altitude": 1024.13,
      "latitude": 26.13246,
      "longitude": 24.34616
    }
  }
}

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

{
  "enabled": true,
  "timeZone": "America/Chicago",
  "provisionStatus": "Completed",
  "provisionStatusCode": null,
  "openShiftsEnabled": true,
  "swapShiftsRequestsEnabled": true,
  "offerShiftRequestsEnabled": true,
  "timeOffRequestsEnabled": true,
  "startDayOfWeek": "Tuesday",
  "activitiesIncludedWhenCopyingShiftsEnabled": true,
  "isCrossLocationShiftsEnabled": true,
  "isCrossLocationShiftRequestApprovalRequired": true,
  "timeClockEnabled": true,
  "timeClockSettings": {
    "approvedLocation": {
      "altitude": 1024.13,
      "latitude": 26.13246,
      "longitude": 24.34616
    }
  }
}

Microsoft Graph service-specific throttling limits