Update emailNotificationsSetting

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 an emailNotificationsSetting object.

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

HTTP request

PATCH /solutions/backupRestore/emailNotificationsSetting

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

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
additionalEvents	notificationEventsType	Indicates whether to opt in to additional policy and restore updates. Possible values: none, restoreAndPolicyUpdates, unknownFutureValue.
isEnabled	Boolean	Indicates whether notifications are enabled.
recipients	notificationRecipients	A list of recipients who receive the notifications.

Response

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

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/solutions/backupRestore/emailNotificationsSetting
Content-Type: application/json

{
  "isEnabled": "true",
  "additionalEvents": "restoreAndPolicyUpdates",
  "recipients": {
    "recipients": {
      "role": "custom",
      "customRecipients": [
        {
          "email": "amala@contoso.com"
        },
        {
          "email": "conrad@contoso.com"
        },
        {
          "email": "lothar@contoso.com"
        }
      ]
    }
  }
}

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

{
  "isEnabled": true,
  "additionalEvents": "restoreAndPolicyUpdates",
  "recipients": {
    "recipients": {
      "role": "custom",
      "customRecipients": [
        {
          "email": "amala@contoso.com"
        },
        {
          "email": "conrad@contoso.com"
        },
        {
          "email": "lothar@contoso.com"
        }
      ]
    }
  }
}