Update Customer Custom Field Values

This request updates customer Custom Field values.

   Click here to learn more about this request

Custom Fields are used by lenders to track information that applies to their business but isn't native to LoanPro. Custom Fields are created and stored within the environment settings and then can be applied to entities such as customers, installment loans, line of credit accounts, and more. To learn the basics of Custom Fields, see Intro to Custom Fields ↗

Here is what's needed to know about this request:

• When a Custom Field is created within the environment settings, the Custom Field is assigned an ID. Afterwards, as the Custom Field is applied to the Customers entity, the Custom Field is assigned a separate ID that represents its relationship to the customer. This request payload requires the ID that represents the Custom Field in relation to the customer. To acquire this ID, send a GET custom fields request.
• The CustomFieldValues object holds Custom Field information, and it's nested within the Customers entity.
• This request updates only the stored value of the Custom Field—not the Custom Field configuration. To update the settings of a custom field, send an Edit Custom Field request.

For an example of how custom fields work within the UI, take a look at our Using Custom Fields article.

Database

For information regarding customer and custom field database tables, see the following articles:

• Database – Custom Field Entity (custom_field)
• Database – Custom Field to Entity Map (custom_field__entity)
• Database – Customer Main Table (customer_entity)

Sample Payload

{
     "CustomFieldValues": {
          "results": [
               {
                    "customFieldValue": "500.00",
                    "__id": 8324,
                    "__update": true
               }
          ]
     }
}