Skip to main content
Updates an existing rule in place, preserving its identity: the ruleId and creation time stay stable, modified is bumped. Only the provided fields change; conditions and actions replace the current ones wholesale when given. Optionally applies the updated rule to existing mail with the same policy (and large-backfill confirmation) as create_mail_rule.

​
Parameters

​
string
required
The rule’s id, as returned by create_mail_rule or listed by list_mail_rules.
​
string
New name.
​
boolean
Enable (true) or pause (false) the rule without deleting it.
​
string
New condition combinator: "all" or "any".
​
object
Replacement conditions (at least one when given).
​
array
Replacement ordered action list.
​
object
Optionally apply the updated rule to existing mail (mode, scope, confirmLargeApply) after saving.

​
Example

Call
Result

​
Errors

  • No mail rule with id <ruleId>. Use list_mail_rules to see the current rules and ids.
  • A denied large backfill updates nothing — re-call with existingMail.confirmLargeApply: true after confirming with the user.