This request updates checklists items associated with an individual loan account.
Click here to learn more about this request
Lenders use SmartSmart Checklists to track servicing practices, monitor progress of processes, and fire off automations. Note the following when updating checklist items associated with a loan account:
Smart Checklist information is stored within the ChecklistItemValues
object nested within the Loans
entity. All Smart Checklists that apply to the loan account—as well as their status—are stored here. However, checklists are configured within the admin-level settings of your environment.
Smart Checklists include both a label status and a checkbox. The status and checkbox of a checklist item can be updated via this request.
Multiple Smart Checklist items can be updated in a single request. Add additional objects to the results
array for each item.
Smart Checklists are a powerful automation tool. Updating a checklist item can fire off Automated Notifications as well as the Automation Engine.
For an example of how smart checklists work within the UI, take a look at our Smart Checklists article.
Database
For more information regarding Smart Checklist database tables, see the following articles:
- Database – Checklist Entity (checklist_entity)
- Database – Tenant Checklist Entity (tenant_checklist_entity)
- Database – Tenant Checklist Category Entity (tenant_checklist_category_entity)
- Database – Checklist item Entity (checklist_item_entity)
- Database – Checklist Item To Checklist Entity Map (checklist_item__entity)
Sample Payloads
{
"ChecklistItemValues": {
"results": [
{
"checklistItemId": 5,
"checklistItemValue": 1,
"statusId": 4
}
]
}
}
{
"ChecklistItemValues": {
"results": [
{
"checklistItemId": 5,
"checklistItemValue": 1,
"statusId": 2
},
{
"checklistItemId": 6,
"checklistItemValue": 0,
"statusId": 3
}
]
}
}