Preview a rule against transactions (dry-run)

POST

/rules/preview

Accepts either a rule_id to load an existing rule, or an inline rule
definition (conditions + actions). Provide an array of transaction_ids
to test against — each transaction must belong to the authenticated user.
No data is persisted.

Action values support Liquid templates for dynamic expressions.
Use {{ transaction.field_name }} to reference fields and Liquid filters
(remove, regex_capture, date_add, remove_at, keep_at, etc.)
to transform values. Plain strings are treated as literal values.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://api.synci.io/oauth/authorize

Token URL: https://api.synci.io/oauth/token

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠401AuthenticationException

🟠403AuthorizationException

🟠422ValidationException

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.synci.io/api/v1/rules/preview' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "rule_id": 0,
    "rule": {
        "trigger_on_any_condition": true,
        "conditions": [
            {
                "field_name": "string",
                "operator": "EQUALS",
                "value": "string",
                "transaction_type": "BANK"
            }
        ],
        "actions": [
            {
                "action_type": "SET_DESTINATION_FIELD",
                "field_name": "string",
                "value": "string",
                "order": 0
            }
        ]
    },
    "transaction_ids": [
        "string"
    ]
}'

Response Example

200 - Example 1

{
    "results": [
        {
            "transaction_id": "string",
            "conditions_matched": true,
            "transaction_summary": {
                "payee": "string",
                "payee_logo": "string",
                "amount": "string",
                "currency": "string",
                "date": "string",
                "description": "string"
            },
            "changes": [
                {
                    "field": "string",
                    "before": "string",
                    "after": "string"
                }
            ],
            "error": "string"
        }
    ],
    "missing_transaction_ids": [
        null
    ]
}

Modified at 2026-07-30 16:30:00

Reorder rules for a financial account

List all rule logs