update_rule

Updates a transaction automation rule by ruleId.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
Preview the prompt that will be copied

Access

  • Effect: Changes data
  • Required scope: write (the mcp scope also grants it)

Example request

The JSON-RPC message an MCP client sends to call this tool. Your client builds it for you; this is for reference and debugging in a tool such as MCP Inspector.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_rule",
    "arguments": {}
  }
}

Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.

Description

Updates a transaction automation rule by ruleId.

Get ruleId from list_rules. If ruleId is unknown, pass ruleName (exact current name) to resolve it; partial names return candidates instead.
Only include the fields you want to change. Supported fields: name, isActive, conditions, actions.

Input parameters

NameTypeRequiredDescription
actionsobjectNo
conditionsobjectNo
isActivebooleanNo
namestringNo
ruleIdstringNo
ruleNamestringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "actions": {
      "additionalProperties": false,
      "properties": {
        "categorySplits": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "basisPoints": {
                "type": "integer"
              },
              "categoryId": {
                "type": "string"
              }
            },
            "required": [
              "categoryId",
              "basisPoints"
            ],
            "type": "object"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "elseCategoryId": {
          "type": [
            "null",
            "string"
          ]
        },
        "notifications": {
          "additionalProperties": false,
          "properties": {
            "email": {
              "type": "boolean"
            },
            "inApp": {
              "type": "boolean"
            },
            "push": {
              "type": "boolean"
            }
          },
          "required": [
            "push",
            "email",
            "inApp"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "taxAssessment": {
          "additionalProperties": false,
          "properties": {
            "businessUsePercent": {
              "type": [
                "null",
                "number"
              ]
            },
            "status": {
              "type": "string"
            },
            "theme": {
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "updateTransactionActions": {
          "additionalProperties": false,
          "properties": {
            "transaction": {
              "additionalProperties": false,
              "properties": {
                "category": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "categoryId": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "description": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "isExcludedFromAnalytics": {
                  "type": [
                    "null",
                    "boolean"
                  ]
                },
                "name": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "tagIds": {
                  "items": {
                    "type": "string"
                  },
                  "type": [
                    "null",
                    "array"
                  ]
                },
                "vendorName": {
                  "type": [
                    "null",
                    "string"
                  ]
                }
              },
              "required": [
                "tagIds"
              ],
              "type": "object"
            },
            "transactionFieldMasks": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "path": {
                    "type": "string"
                  }
                },
                "required": [
                  "path"
                ],
                "type": "object"
              },
              "type": [
                "null",
                "array"
              ]
            }
          },
          "required": [
            "transaction",
            "transactionFieldMasks"
          ],
          "type": "object"
        }
      },
      "required": [
        "updateTransactionActions"
      ],
      "type": [
        "null",
        "object"
      ]
    },
    "conditions": {
      "additionalProperties": false,
      "properties": {
        "accountId": {
          "type": [
            "null",
            "string"
          ]
        },
        "amountRange": {
          "additionalProperties": false,
          "properties": {
            "max": {
              "type": [
                "null",
                "number"
              ]
            },
            "min": {
              "type": [
                "null",
                "number"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "categoryId": {
          "type": [
            "null",
            "string"
          ]
        },
        "dateRange": {
          "additionalProperties": false,
          "properties": {
            "endDate": {
              "type": [
                "null",
                "string"
              ]
            },
            "startDate": {
              "type": [
                "null",
                "string"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "merchantNames": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "source": {
          "type": [
            "null",
            "string"
          ]
        },
        "tagIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "vendorId": {
          "type": [
            "null",
            "string"
          ]
        },
        "vendorName": {
          "type": [
            "null",
            "string"
          ]
        },
        "vendorNameContains": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": [
        "null",
        "object"
      ]
    },
    "isActive": {
      "type": [
        "null",
        "boolean"
      ]
    },
    "name": {
      "type": [
        "null",
        "string"
      ]
    },
    "ruleId": {
      "type": "string"
    },
    "ruleName": {
      "type": [
        "null",
        "string"
      ]
    }
  },
  "type": "object"
}