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
}
'
{
  "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"
}

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