SYsynci
Rules

Preview a rule against transactions (dry-run)

Changed on

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.

post/rules/preview

Request

  • Base URL
    https://api.synci.io/api/v1
  • Auth
    • OAuth 2
      Authorization code: https://api.synci.io/oauth/authorize
      Token URL: https://api.synci.io/oauth/token
    • or HTTP bearer

Request body

rule_idinteger nullable

The ID of an existing rule to preview. Omit to provide an inline rule definition instead.

transaction_idsstring[] required

The IDs of the transactions to preview the rule against. The transactions must belong to the authenticated user. Maximum 25 per request.

Response

Changes

  • 77c60670768eRevision changes
    • info

      the request property became nullable

  • bd0918c24b26Revision changes
    • breaking

      the /// response's property type changed from string null to no type for status

    • breaking

      the /// response's property type changed from string null to no type for status