Rules

Update rule

Any field may be omitted to leave it unchanged. For rules that have been migrated, only name, description, enabled, and the value of existing actions can be updated.

PUT

/rules/{ruleId}

Update rule

curl --request PUT \
  --url https://api.synci.io/api/v1/rules/{ruleId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "actions": [
      {
        "action_type": "<string>",
        "created_at": "<string>",
        "field_name": "memo",
        "id": "<string>",
        "order": "<string>",
        "rules": [
          {}
        ],
        "rules_count": "<string>",
        "updated_at": "<string>",
        "value": "{{ transaction.remittance_information.unstructured | remove: \"REF \" }}"
      }
    ],
    "actions_count": "<string>",
    "compatible_destinations": [
      "<string>"
    ],
    "conditions": [
      {
        "created_at": "<string>",
        "field_name": "currency",
        "id": "<string>",
        "operator": "EQUALS",
        "rules": [
          {}
        ],
        "rules_count": "<string>",
        "transaction_type": "BANK",
        "updated_at": "<string>",
        "value": "NOK"
      }
    ],
    "conditions_count": "<string>",
    "created_at": "<string>",
    "description": "<string>",
    "enabled": "<string>",
    "financial_accounts": [
      {
        "financial_account": {
          "account_category": "<string>",
          "account_number_masked": "<string>",
          "account_usage": "<string>",
          "balance": {
            "available": "<string>",
            "cleared": "<string>"
          },
          "balances_last_synced_at": "<string>",
          "bban": "<string>",
          "bic": "<string>",
          "cash_account_type": "<string>",
          "cash_balance": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "config": {
            "enrichment": {
              "country": "<string>",
              "enabled": "<string>",
              "provider": "<string>"
            },
            "fields_for_duplicate_filtering": [
              "<string>"
            ],
            "fuzzy_counterparty_matching": "<string>",
            "fuzzy_counterparty_min_chars": "<string>",
            "map_fields": {
              "date": "<string>",
              "description": "<string>",
              "payee": "<string>"
            },
            "pending_settlement_matching": "<string>",
            "pending_settlement_max_days": "<string>",
            "sync_auto": "<string>",
            "sync_balances": "<string>",
            "sync_frequency_in_minutes": "<string>",
            "sync_pending_transactions": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ruleIdintegerrequired

The rule ID

Body

actionsstring

Show child attributes

conditionsany[]

The full set of conditions for the rule. Include an id on an entry to update an existing condition, or omit it to create a new one. Each entry has the same shape as in the create-rule endpoint.

descriptionstring | null

An optional description of what the rule does.

Maximum string length: 192

enabledboolean

Whether the rule is active. Disabled rules are not applied.

financial_accountsany[]

The financial accounts the rule is attached to, each as { id, order }. Only accepted for rules attached to financial accounts.

namestring

The name of the rule.

Maximum string length: 64

skip_other_rules_when_triggeredboolean

When true, no further rules are evaluated once this rule triggers.

transfer_linksany[]

The transfer links the rule is attached to, each as { id, order }. Only accepted for rules attached to transfer links.

trigger_on_any_conditionboolean

When true, the rule triggers if any condition matches; when false, all conditions must match.

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team