Reconciliation

Update matching rule

Replace the name, description, or criteria of a matching rule.

PUT/reconciliation/matching-rules/{rule_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

rule_idstringrequiredpath

Id of the rule to update. An unknown id returns 404 with RECON_RULE_NOT_FOUND.

Body

namestringrequiredbody

Name of the rule.

descriptionstringbody

What the rule is for.

criteriaobject[]requiredbody

Comparisons that must all match. Same fields as Create matching rule.

Criterion

fieldstringrequiredbody

amount, currency, date, reference, or description.

operatorstringrequiredbody

equals, greater_than, less_than, or contains.

allowable_driftnumberbody

On equals, a fraction from 0 to 1 for amount, or seconds for date. On contains, divided by 100 and applied to the longer string when neither value includes the other.

Response

rule_idstringrequired

Id of the rule. Unchanged by the update.

namestringrequired

Name of the rule.

descriptionstring

What the rule is for.

criteriaobject[]required

The criteria that were stored. Each criterion also includes value and pattern. Matching does not read them.

created_atstringrequired

When the rule was first created. Not changed by the update.

updated_atstringrequired

When this update was saved.

curl -X PUT "http://localhost:5001/reconciliation/matching-rules/rule_890bdbc4-467f-4670-8424-5667e41daf29" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated matcher",
    "description": "Amount with 2% drift matcher",
    "criteria": [
      {
        "field": "amount",
        "operator": "equals",
        "allowable_drift": 0.02
      },
      {
        "field": "currency",
        "operator": "equals"
      },
      {
        "field": "reference",
        "operator": "contains"
      }
    ]
  }'

{
  "rule_id": "rule_890bdbc4-467f-4670-8424-5667e41daf29",
  "name": "Updated matcher",
  "description": "Amount with 2% drift matcher",
  "criteria": [
    {
      "field": "amount",
      "operator": "equals",
      "value": "",
      "pattern": "",
      "allowable_drift": 0.02
    },
    {
      "field": "currency",
      "operator": "equals",
      "value": "",
      "pattern": "",
      "allowable_drift": 0
    },
    {
      "field": "reference",
      "operator": "contains",
      "value": "",
      "pattern": "",
      "allowable_drift": 0
    }
  ],
  "created_at": "2025-03-17T08:31:24.97610651Z",
  "updated_at": "2025-03-17T09:02:11.120441Z"
}

{
  "error": "invalid operator",
  "error_detail": {
    "code": "RECON_RULE_INVALID",
    "message": "invalid operator"
  }
}

{
  "error": "Matching rule with ID 'rule_00000000-0000-0000-0000-000000000000' not found",
  "error_detail": {
    "code": "RECON_RULE_NOT_FOUND",
    "message": "Matching rule with ID 'rule_00000000-0000-0000-0000-000000000000' not found"
  }
}