Update settings

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 the userSettings object. Users in the same organization can have different settings based on their preference or on the organization policies. To get the user current settings, see current user settings.

Batch request

It's also possible to opt-out multiple users from Delve through a batch request. To learn more, see JSON batching.

Important: Only members of the organization management role group can update multiple users.

Permissions

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

HTTP request

PATCH /me/settings

Request with a 'user id' or 'userPrincipalName' is only accessible by the user or by a user with the User.ReadWrite.All permissions. To learn more, see Permissions.

PATCH /users/{id | userPrincipalName}/settings/

Request headers

Header	Value
Authorization	Bearer {token}. Required.
Content-Type	application/json

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Property	Type	Description
contributionToContentDiscoveryDisabled	Boolean	Set to true to disable access to documents in Office Delve for the user. This setting reflects the control state in Office Delve.

Example

Request

Here is an example request on how to opt-out a user from Delve and disable his contribution on content relevancy for the whole organization.

PATCH https://graph.microsoft.com/beta/me/settings
Content-type: application/json

{
  "contributionToContentDiscoveryDisabled": true
}

Response

Here is an example of the response. Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "contributionToContentDiscoveryAsOrganizationDisabled": false,
  "contributionToContentDiscoveryDisabled": true
}