Updates field values for a specified loan file. Adds, replaces, or removes field lock data.

🚧

No validation errors are returned for non-editable option fields (e.g., field 19 "Loan Purpose Type"). If an invalid value is provided, this API will clear the existing value in the field and will not return an error. This behavior will be enhanced in a future release.

The Field Writer API updates the values of fields by Field IDs rather than JSON paths for a given loan. This is an alternative to the Update Loan API, and is especially helpful when trying to update specific fields by field IDs. This API also provides the ability to lock and unlock fields with padlocks.

Use the Field Writer API to update field values for a loan. You can update standard fields and custom fields (Loan Custom Fields, Lock Request Additional Custom Fields, TPO Custom Fields) through this API. The same Business Rules and Persona checks that would apply to Update loan call will apply to this Field Writer API as well.

❗️

Please note, not all fields can be updated. Refer to the V3 Get Field Schema API for standard field definitions.

📘

As a general guideline for all V3 APIs, send date/datetime fields only in the following ISO formats:

• date-times: yyyy-MM-ddTHH:mm:ssZ
• dates: yyyy-MM-dd

Usage Notes

Supported Field Types

• The fieldWriter API supports standard and custom field IDs.
• Canonical field IDs are not supported and should not be used.