Update rule

Namespace: microsoft.graph

Change writable properties on a messageRule object and save the changes.

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) MailboxSettings.ReadWrite Not available.
Delegated (personal Microsoft account) MailboxSettings.ReadWrite Not available.
Application MailboxSettings.ReadWrite Not available.

HTTP request

PATCH /me/mailFolders/inbox/messageRules/{id}
PATCH /users/{id | userPrincipalName}/mailFolders/inbox/messageRules/{id}

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 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
actions messageRuleActions Actions to be taken on a message when the corresponding conditions are fulfilled.
conditions messageRulePredicates Conditions that when fulfilled, will trigger the corresponding actions for that rule.
displayName String The display name of the rule.
exceptions messageRulePredicates Exception conditions for the rule.
isEnabled Boolean Indicates whether the rule is enabled to be applied to messages.
isReadOnly Boolean Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
sequence Int32 Indicates the order in which the rule is executed, among other rules.

Response

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

Example

Request

The following example changes the name of the rule, and the actions to be taken for that rule in the example in Get rule, from forwarding to an address to marking its importance as high.

PATCH https://graph.microsoft.com/v1.0/me/mailFolders/inbox/messageRules/AQAAAJ5dZqA=
Content-type: application/json

{
    "displayName": "Important from partner",
    "actions": {
        "markImportance": "high"
     }
}
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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Me/mailFolders('inbox')/messageRules/$entity",
  "id":"AQAAAJ5dZqA=",
  "displayName":"Important from partner",
  "sequence":2,
  "isEnabled":true,
  "hasError":false,
  "isReadOnly":false,
  "conditions":{
    "senderContains":[
      "ADELE"
    ]
  },
  "actions":{
    "markImportance": "high"
  }
}