Set a loan file's custom field values

Set custom field values on one loan file.

Partial update. Only the fields you list are written; anything you
leave out is untouched. An explicit null clears a value. ⚠️ Except an SSN-type
field from a tenant API key whose PII setting is "No": it reads those as null, so its
null is ignored, never a clear. A real value from it still writes.

You can send back what you read. GET on this same path returns
{id, key, value} items, and this endpoint accepts exactly that —
key is accepted and ignored, and the nulls the read emits for
unanswered fields are accepted rather than refused. So read, change one
value, and send the whole body back.

An item you send back unchanged writes nothing. It is not validated,
not re-stamped and not copied to the borrower profile, so echoing a
field you did not touch can never change it, and a stored choice the
portal has since removed from the option list can be sent back as it
was. Only the items whose value differs from what is stored are saved.
Read-only fields are the exception, below: they are refused whatever
their value.

What is refused, all in a single 422 listing every problem rather
than the first one: a field id that is not on this loan (including one
that lives only on the borrower profile), a read-only field (Function or
file), a value outside
the option list of a dropdown or radio, a list sent to a field that
holds a single value, a value longer than 65,535 bytes, and an amount
too large for its column.

Numbers may be sent as JSON numbers or as strings — 90210 and
"90210" are equivalent. They are stored exactly as the portal stores
the string form.

⛔ Read-only fields are refused, not quietly ignored. Two kinds of
field are returned by the GET but cannot be written here, and naming
either one in a PATCH is a 422:

  • Function fields — their value is calculated from other fields by
    a formula configured in the portal. There is no value to set.
  • File fields — setting the storage id without uploading the
    document behind it would be half an operation.

⚠️ So a GET body is not directly re-sendable as a PATCH body.
Drop read-only fields before sending. This is deliberate: accepting the
value and doing nothing would answer 200 to a write that never
happened, and being told a write succeeded when it did not is the worse
failure. A Function field is refused even when the value you send
matches the one currently calculated.

⚠️ One side effect you should know about. A field that is also shown
on the borrower profile writes the borrower's copy too, but only while
the loan file is 30 days old or less. After that the two values are
independent and this endpoint changes only the loan's. This mirrors what
the portal does.

⛔ No automations run. Automation rules cannot be set up against a
custom field, so nothing is triggered by changing one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

The loan file id.

Body Params
items
array of objects
required
length between 1 and 500
items*
integer
required
≥ 1

The custom field id, from /api/v4/custom-fields.

string

Accepted and ignored. It is here so a body read from GET can be sent straight back without editing.

string
required

The value to store, or null to clear it. Match the shape to the field's type — a list for checkboxes and multi-selects, YYYY-MM-DD or any parseable date for dates, otherwise a string or number.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json