Skip to main content
PATCH
/
rules
/
{ruleId}
Update a transaction rule
curl --request PATCH \
  --url https://api.finta.io/v2/rules/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conditions": [
    {}
  ],
  "outcomes": [
    {}
  ],
  "priority": 50
}
'
import requests

url = "https://api.finta.io/v2/rules/{ruleId}"

payload = {
"conditions": [{}],
"outcomes": [{}],
"priority": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({conditions: [{}], outcomes: [{}], priority: 50})
};

fetch('https://api.finta.io/v2/rules/{ruleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finta.io/v2/rules/{ruleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'conditions' => [
[

]
],
'outcomes' => [
[

]
],
'priority' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.finta.io/v2/rules/{ruleId}"

payload := strings.NewReader("{\n \"conditions\": [\n {}\n ],\n \"outcomes\": [\n {}\n ],\n \"priority\": 50\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.finta.io/v2/rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conditions\": [\n {}\n ],\n \"outcomes\": [\n {}\n ],\n \"priority\": 50\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.finta.io/v2/rules/{ruleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conditions\": [\n {}\n ],\n \"outcomes\": [\n {}\n ],\n \"priority\": 50\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conditions": [
    {}
  ],
  "outcomes": [
    {}
  ],
  "priority": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}
{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}
{
"error": "Missing or invalid Authorization header"
}
{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}
{
"error": {
"code": "STORAGE_MODE_REQUIRED",
"message": "<string>"
}
}
{
"error": {
"code": "RATE_LIMITED",
"message": "Per-minute rate limit exceeded (10 requests/min on Standard plan)."
}
}

Authorizations

Authorization
string
header
required

Finta API key from the dashboard (Bearer token).

Path Parameters

ruleId
string<uuid>
required

Transaction rule UUID

Body

application/json
conditions
object[]

Conditions match transactions on Account, Summary, OriginalDescription, MerchantName, Amount, or transactionDay. Each condition is an object describing a field and how to match it.

Minimum array length: 1
outcomes
object[]

Outcomes applied to matching transactions. Set Category ({ action: 'updateTransaction', field: 'Category', value: { id, value } }) or MerchantName, or hide the transaction ({ action: 'hideTransaction', value: true }).

Minimum array length: 1
priority
integer
Required range: 1 <= x <= 100

Response

Updated transaction rule

id
string<uuid>
required
conditions
object[]
required
outcomes
object[]
required
priority
integer
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
archivedAt
string<date-time> | null
required