Update openShift

Namespace: microsoft.graph

Update the properties of an openShift 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 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.

Note: This API supports admin permissions. Users with admin roles can access groups that they are not a member of.

HTTP request

PUT /teams/{id}/schedule/openShifts/{openShiftId}

Request headers

Name	Description
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 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
draftOpenShift	openShiftItem	Draft changes in the openShift are only visible to managers until they're shared. Either draftOpenShift or sharedOpenShift should be null.
isStagedForDeletion	Boolean	The openShift is marked for deletion, a process that is finalized when the schedule is shared. Optional.
schedulingGroupId	String	The ID of the schedulingGroup that contains the openShift.
sharedOpenShift	openShiftItem	The shared version of this openShift that is viewable by both employees and managers. Either draftOpenShift or sharedOpenShift should be null.

Response

If successful, this method returns a 204 No Content response code and empty content. If the request specifies the Prefer header with return=representation preference, then this method returns a 200 OK response code and an updated openShift object in the response body.

Examples

Request

The following example shows a request.

HTTP

PUT https://graph.microsoft.com/v1.0/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/openShifts/OPNSHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8
Content-Type: application/json

{
  "schedulingGroupId": "TAG_4ab7d329-1f7e-4eaf-ba93-63f1ff3f3c4a",
  "sharedOpenShift": {
    "displayName": null,
    "startDateTime": "2024-11-04T20:00:00Z",
    "endDateTime": "2024-11-04T21:00:00Z",
    "theme": "blue",
    "notes": null,
    "openSlotCount": 1,
    "activities": []
  },
  "draftTimeOff": null,
  "isStagedForDeletion": false
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const openShift = {
  schedulingGroupId: 'TAG_4ab7d329-1f7e-4eaf-ba93-63f1ff3f3c4a',
  sharedOpenShift: {
    displayName: null,
    startDateTime: '2024-11-04T20:00:00Z',
    endDateTime: '2024-11-04T21:00:00Z',
    theme: 'blue',
    notes: null,
    openSlotCount: 1,
    activities: []
  },
  draftTimeOff: null,
  isStagedForDeletion: false
};

await client.api('/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/schedule/openShifts/OPNSHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8')
	.put(openShift);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content