Update Loan Rules Applied Settings

This request updates the Rules Applied settings for a loan.

   Click here to learn more about this request

Here's what you need to know about updating Rules Applied settings on your loans:

• Rules Applied are created at the tenant level to apply to all of your loans. However, you have the ability to determine which loans the rules are active on, which is what this request does. This request does not create, edit, or delete the rules themselves. Instead, it simply determines which rules are active on a specific loan.
• When a rule is set as 'inactive', the system won't check the loan for the criteria needed, and it won't complete the rule's determined action.
• Using this request to set a rule as 'inactive' will only do so for the selected loan. How the rule applies to all other loans within your tenant account will remain the same.

Database

For information on rules applied database tables, see the following articles:

• Database – Rule Applied Settings - Loan Relations (loan__rule_applied_settings)
• Database – Rule Applied Entity (rule_applied_entity)

Sample Payload - Inactivate Rule

{
    "RuleApplied": {
        "results": [
            {
                "__id": "21",
                "enabled": false,
                "__destroy": true
            }
        ]
    }
}

Sample Payload - Activate Rule

{
    "RuleApplied": {
        "results": [
            {
                "__id": "21",
                "enabled": true,
                "__destroy": false
            }
        ]
    }
}

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.