rules

Fire the rule on your transactions.

Fire the rule group on your transactions. Changes will be made by the rules in the group. Limit the result if you want to.

post/v1/rules/{id}/trigger

Path parameters

idstring required
Example:123

The ID of the rule.

Query parameters

startstring date
Example:2026-08-01

A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. If the start date is not present, it will be set to one year ago. If you use this field, both the start date and the end date must be present.

endstring date
Example:2026-08-31

A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. If the end date is not present, it will be set to today. If you use this field, both the start date and the end date must be present.

accounts[]integer[]

Limit the triggering of the rule to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.

[
  1,
  2,
  3
]

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

The rules in the group are executed. Due to the setup of this function (asynchronous job execution) the result cannot be displayed.

Changes

No recorded changes to this endpoint across all 1 revision of this API.