V3 Field Writer

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.

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.
Path Params
string
required

Unique identifier of the loan for which to update field values.

Query Params
string

Can be passed if a lock has been acquired on the loan.

Body Params
json

The Field Writer contract. Use the data provided in the Field Writer Contract.

Supported field types: standard, custom and virtual field IDs. Canonical fields are not supported.

Headers
string
required

Bearer token

Responses

Language
Response
Choose an example:
application/json